@awarevue/api-types 2.0.152 → 2.0.154

package/dist/api/rest/layout.js

@@ -3,25 +3,55 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sUpdateLayoutRequest = exports.sAddLayoutRequest = void 0;
+exports.sUpdateLayoutRequest = exports.sAddLayoutRequest = exports.sAddImageOrMapLayoutRequest = exports.sAddMapLayoutRequest = exports.sAddImageLayoutRequest = void 0;
 const layout_1 = require("../../objects/layout");
 const zod_1 = __importDefault(require("zod"));
-exports.sAddLayoutRequest = zod_1.default.object({
+const sAddLayoutBase = zod_1.default.object({
     name: zod_1.default.string().nonempty(),
-    thumbnailId: zod_1.default.string().nonempty(),
-    imageId: zod_1.default.string().nonempty(),
     order: zod_1.default.number().optional(),
     devices: zod_1.default.array(layout_1.sLayoutDeviceDto),
     colorize: zod_1.default.boolean(),
-    map: zod_1.default.boolean(),
 });
+exports.sAddImageLayoutRequest = sAddLayoutBase.extend({
+    kind: zod_1.default.literal('image'),
+    thumbnailId: zod_1.default.string().nonempty(),
+    imageId: zod_1.default.string().nonempty(),
+});
+exports.sAddMapLayoutRequest = sAddLayoutBase.extend({
+    kind: zod_1.default.literal('map'),
+});
+/** An image layout, or a map layout when `map` is true, chosen by a flag rather than by `kind`. */
+exports.sAddImageOrMapLayoutRequest = sAddLayoutBase.extend({
+    thumbnailId: zod_1.default.string().nonempty(),
+    imageId: zod_1.default.string().nonempty(),
+    map: zod_1.default.boolean().describe('True for a map layout, false for an image layout'),
+});
+/** `3d` layouts are created by importing their model (POST /layouts/models). */
+exports.sAddLayoutRequest = zod_1.default.union([
+    zod_1.default.discriminatedUnion('kind', [exports.sAddImageLayoutRequest, exports.sAddMapLayoutRequest]),
+    exports.sAddImageOrMapLayoutRequest,
+]);
 exports.sUpdateLayoutRequest = zod_1.default.object({
     name: zod_1.default.string().optional(),
-    thumbnailId: zod_1.default.string().optional(),
-    imageId: zod_1.default.string().optional(),
+    thumbnailId: zod_1.default
+        .string()
+        .optional()
+        .describe('Not for 3d layouts, which have no image'),
+    imageId: zod_1.default
+        .string()
+        .optional()
+        .describe('Not for 3d layouts, which have no image'),
     order: zod_1.default.number().optional(),
     isDefault: zod_1.default.boolean().optional(),
     devices: zod_1.default.array(layout_1.sLayoutDeviceDto).optional(),
+    placementsRev: zod_1.default
+        .number()
+        .int()
+        .optional()
+        .describe("The layout's placementsRev the devices were edited from. When sent with devices, the save is refused if someone else saved meanwhile."),
     colorize: zod_1.default.boolean().optional(),
-    map: zod_1.default.boolean().optional(),
+    map: zod_1.default
+        .boolean()
+        .optional()
+        .describe('Ignored: a layout keeps the kind it was made with'),
 });

package/dist/api/rest/trackables.d.ts

@@ -6,6 +6,12 @@ export declare const sTrackableProfileSnapshot: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
 }, z.core.$strip>;
 export declare const sSetTrackableFavoriteRequest: z.ZodObject<{
@@ -15,6 +21,12 @@ export declare const sSetTrackableFavoriteRequest: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
 }, z.core.$strip>;
 export type SetTrackableFavoriteRequest = z.infer<typeof sSetTrackableFavoriteRequest>;
@@ -25,6 +37,12 @@ export declare const sCreateTrackableRequest: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
     objectId: z.ZodString;
 }, z.core.$strip>;
@@ -36,6 +54,12 @@ export declare const sUpdateTrackableRequest: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
 }, z.core.$strip>;
 export type UpdateTrackableRequest = z.infer<typeof sUpdateTrackableRequest>;
@@ -46,6 +70,12 @@ export declare const sAttachTrackableImageRequest: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
     imageId: z.ZodUUID;
     reviewed: z.ZodOptional<z.ZodBoolean>;
@@ -63,6 +93,12 @@ export declare const sCreateTrackableRetentionPolicyRequest: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>;
 }, z.core.$strip>;
 export type CreateTrackableRetentionPolicyRequest = z.infer<typeof sCreateTrackableRetentionPolicyRequest>;

package/dist/api/ws/trackables.d.ts

@@ -9,6 +9,12 @@ export declare const sTrackableUpdate: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
     metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     longitude: z.ZodOptional<z.ZodNumber>;
@@ -36,6 +42,12 @@ export declare const sTrackableUpdatePayload: z.ZodObject<{
             "base-station": "base-station";
             "aid-to-navigation": "aid-to-navigation";
             "sar-aircraft": "sar-aircraft";
+            aircraft: "aircraft";
+            helicopter: "helicopter";
+            glider: "glider";
+            balloon: "balloon";
+            drone: "drone";
+            "ground-vehicle": "ground-vehicle";
         }>>;
         metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         longitude: z.ZodOptional<z.ZodNumber>;

package/dist/objects/layout.d.ts

@@ -1,4 +1,51 @@
 import { z } from 'zod';
+/**
+ * What a layout's document is, fixed when the layout is created:
+ * - `image`: a plan image (SVG/PNG); devices are placed on the image.
+ * - `map`: the world map; devices are placed on the map.
+ * - `3d`: a 3D model (model.json plus plan images); devices are placed on the model's levels, in metres.
+ */
+export declare const sLayoutKind: z.ZodEnum<{
+    map: "map";
+    image: "image";
+    "3d": "3d";
+}>;
+export type LayoutKind = z.infer<typeof sLayoutKind>;
+/** Four points in a camera's picture, as fractions of its width and height, and the four level points they show. */
+export declare const sCameraCalibration: z.ZodObject<{
+    img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+}, z.core.$strip>;
+export type CameraCalibration = z.infer<typeof sCameraCalibration>;
+/** Placement attributes that only some device types use. Absent keys take the device type's defaults. */
+export declare const sLayoutDeviceExtras: z.ZodObject<{
+    width: z.ZodOptional<z.ZodNumber>;
+    hinge: z.ZodOptional<z.ZodEnum<{
+        start: "start";
+        end: "end";
+    }>>;
+    opens: z.ZodOptional<z.ZodEnum<{
+        right: "right";
+        left: "left";
+    }>>;
+    size: z.ZodOptional<z.ZodNumber>;
+    room: z.ZodOptional<z.ZodString>;
+    viewId: z.ZodOptional<z.ZodString>;
+    calibration: z.ZodOptional<z.ZodObject<{
+        img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+    }, z.core.$strip>>;
+    zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+}, z.core.$strip>;
+export type LayoutDeviceExtras = z.infer<typeof sLayoutDeviceExtras>;
+/**
+ * A device placed on a layout. What x, y and rotation mean depends on the layout's kind:
+ * - `image` and `map`: a position on the image or map, as the layout editor stores it.
+ * - `3d`: metres on the level, x along the model's x axis (towards the bow) and y along its z axis; rotation is the
+ *   heading in degrees, 0 towards +x and 90 towards +y; scale is 1.
+ *
+ * In requests, `level`, `height` and `extras` left out keep their stored values, and null clears them.
+ */
 export declare const sLayoutDeviceDto: z.ZodObject<{
     deviceId: z.ZodString;
     x: z.ZodNumber;
@@ -8,13 +55,77 @@ export declare const sLayoutDeviceDto: z.ZodObject<{
     fov: z.ZodNumber;
     far: z.ZodNumber;
     displayAs: z.ZodNullable<z.ZodString>;
+    level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        width: z.ZodOptional<z.ZodNumber>;
+        hinge: z.ZodOptional<z.ZodEnum<{
+            start: "start";
+            end: "end";
+        }>>;
+        opens: z.ZodOptional<z.ZodEnum<{
+            right: "right";
+            left: "left";
+        }>>;
+        size: z.ZodOptional<z.ZodNumber>;
+        room: z.ZodOptional<z.ZodString>;
+        viewId: z.ZodOptional<z.ZodString>;
+        calibration: z.ZodOptional<z.ZodObject<{
+            img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+        }, z.core.$strip>>;
+        zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type LayoutDeviceDto = z.infer<typeof sLayoutDeviceDto>;
-export declare const sLayoutDto: z.ZodObject<{
+export declare const sImageLayoutDto: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodString;
-    thumbnailUrl: z.ZodString;
+    order: z.ZodNumber;
+    isDefault: z.ZodBoolean;
+    devices: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        scale: z.ZodNumber;
+        rotation: z.ZodNumber;
+        fov: z.ZodNumber;
+        far: z.ZodNumber;
+        displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
+    map: z.ZodBoolean;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"image">;
     imageUrl: z.ZodString;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const sMapLayoutDto: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
     order: z.ZodNumber;
     isDefault: z.ZodBoolean;
     devices: z.ZodArray<z.ZodObject<{
@@ -26,10 +137,221 @@ export declare const sLayoutDto: z.ZodObject<{
         fov: z.ZodNumber;
         far: z.ZodNumber;
         displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
     }, z.core.$strip>>;
     colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
     map: z.ZodBoolean;
     createdOn: z.ZodString;
     lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"map">;
+    imageUrl: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+export declare const sModelLayoutDto: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isDefault: z.ZodBoolean;
+    devices: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        scale: z.ZodNumber;
+        rotation: z.ZodNumber;
+        fov: z.ZodNumber;
+        far: z.ZodNumber;
+        displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
+    map: z.ZodBoolean;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"3d">;
+}, z.core.$strip>;
+export declare const sLayoutDto: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isDefault: z.ZodBoolean;
+    devices: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        scale: z.ZodNumber;
+        rotation: z.ZodNumber;
+        fov: z.ZodNumber;
+        far: z.ZodNumber;
+        displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
+    map: z.ZodBoolean;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"image">;
+    imageUrl: z.ZodString;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isDefault: z.ZodBoolean;
+    devices: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        scale: z.ZodNumber;
+        rotation: z.ZodNumber;
+        fov: z.ZodNumber;
+        far: z.ZodNumber;
+        displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
+    map: z.ZodBoolean;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"map">;
+    imageUrl: z.ZodOptional<z.ZodString>;
+    thumbnailUrl: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodString;
+    order: z.ZodNumber;
+    isDefault: z.ZodBoolean;
+    devices: z.ZodArray<z.ZodObject<{
+        deviceId: z.ZodString;
+        x: z.ZodNumber;
+        y: z.ZodNumber;
+        scale: z.ZodNumber;
+        rotation: z.ZodNumber;
+        fov: z.ZodNumber;
+        far: z.ZodNumber;
+        displayAs: z.ZodNullable<z.ZodString>;
+        level: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        height: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        extras: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            width: z.ZodOptional<z.ZodNumber>;
+            hinge: z.ZodOptional<z.ZodEnum<{
+                start: "start";
+                end: "end";
+            }>>;
+            opens: z.ZodOptional<z.ZodEnum<{
+                right: "right";
+                left: "left";
+            }>>;
+            size: z.ZodOptional<z.ZodNumber>;
+            room: z.ZodOptional<z.ZodString>;
+            viewId: z.ZodOptional<z.ZodString>;
+            calibration: z.ZodOptional<z.ZodObject<{
+                img: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+                level: z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>>;
+            }, z.core.$strip>>;
+            zoneRooms: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+    colorize: z.ZodBoolean;
+    placementsRev: z.ZodNumber;
+    map: z.ZodBoolean;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+    kind: z.ZodLiteral<"3d">;
+}, z.core.$strip>], "kind">;
+export type ImageLayoutDto = z.infer<typeof sImageLayoutDto>;
+export type MapLayoutDto = z.infer<typeof sMapLayoutDto>;
+export type ModelLayoutDto = z.infer<typeof sModelLayoutDto>;
 export type LayoutDto = z.infer<typeof sLayoutDto>;
+/** The document of a `3d` layout: its model definition and the plan images the definition names. */
+export declare const sLayoutModelDto: z.ZodObject<{
+    definition: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    plans: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        url: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type LayoutModelDto = z.infer<typeof sLayoutModelDto>;

package/dist/objects/layout.js

@@ -1,7 +1,69 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sLayoutDto = exports.sLayoutDeviceDto = void 0;
+exports.sLayoutModelDto = exports.sLayoutDto = exports.sModelLayoutDto = exports.sMapLayoutDto = exports.sImageLayoutDto = exports.sLayoutDeviceDto = exports.sLayoutDeviceExtras = exports.sCameraCalibration = exports.sLayoutKind = void 0;
 const zod_1 = require("zod");
+/**
+ * What a layout's document is, fixed when the layout is created:
+ * - `image`: a plan image (SVG/PNG); devices are placed on the image.
+ * - `map`: the world map; devices are placed on the map.
+ * - `3d`: a 3D model (model.json plus plan images); devices are placed on the model's levels, in metres.
+ */
+exports.sLayoutKind = zod_1.z.enum(['image', 'map', '3d']);
+const sPoint = zod_1.z.tuple([zod_1.z.number(), zod_1.z.number()]);
+/** Four points in a camera's picture, as fractions of its width and height, and the four level points they show. */
+exports.sCameraCalibration = zod_1.z.object({
+    img: zod_1.z.array(sPoint).length(4),
+    level: zod_1.z.array(sPoint).length(4),
+});
+/** Placement attributes that only some device types use. Absent keys take the device type's defaults. */
+exports.sLayoutDeviceExtras = zod_1.z.object({
+    width: zod_1.z
+        .number()
+        .min(0.4)
+        .max(4)
+        .optional()
+        .describe('Door: width of the doorway in metres'),
+    hinge: zod_1.z
+        .enum(['start', 'end'])
+        .optional()
+        .describe('Door: the end of the doorway, along its rotation, the hinge is at (default start)'),
+    opens: zod_1.z
+        .enum(['right', 'left'])
+        .optional()
+        .describe('Door: the side of the doorway, looking along its rotation, the door swings to (default right)'),
+    size: zod_1.z
+        .number()
+        .min(0.3)
+        .max(6)
+        .optional()
+        .describe('Size of the device marker in metres'),
+    room: zod_1.z
+        .string()
+        .min(1)
+        .max(64)
+        .optional()
+        .describe("Room of the layout's document the device belongs to, when not the one it stands in"),
+    viewId: zod_1.z
+        .string()
+        .nonempty()
+        .optional()
+        .describe('View to open from the device'),
+    calibration: exports.sCameraCalibration
+        .optional()
+        .describe("Camera: maps points in the camera's picture to its level"),
+    zoneRooms: zod_1.z
+        .record(zod_1.z.string().min(1).max(128), zod_1.z.string().min(1).max(64))
+        .optional()
+        .describe("Camera: the detection provider's zone names, to rooms of the layout's document"),
+});
+/**
+ * A device placed on a layout. What x, y and rotation mean depends on the layout's kind:
+ * - `image` and `map`: a position on the image or map, as the layout editor stores it.
+ * - `3d`: metres on the level, x along the model's x axis (towards the bow) and y along its z axis; rotation is the
+ *   heading in degrees, 0 towards +x and 90 towards +y; scale is 1.
+ *
+ * In requests, `level`, `height` and `extras` left out keep their stored values, and null clears them.
+ */
 exports.sLayoutDeviceDto = zod_1.z.object({
     deviceId: zod_1.z.string(),
     x: zod_1.z.number(),
@@ -11,17 +73,66 @@ exports.sLayoutDeviceDto = zod_1.z.object({
     fov: zod_1.z.number(),
     far: zod_1.z.number(),
     displayAs: zod_1.z.string().nullable(),
+    level: zod_1.z
+        .string()
+        .min(1)
+        .max(64)
+        .nullable()
+        .optional()
+        .describe("Level of the layout's document the device is on (3d: the model's deck id)"),
+    height: zod_1.z
+        .number()
+        .min(0)
+        .max(100)
+        .nullable()
+        .optional()
+        .describe('Metres above the level'),
+    extras: exports.sLayoutDeviceExtras.nullable().optional(),
 });
-exports.sLayoutDto = zod_1.z.object({
+const sLayoutBase = zod_1.z.object({
     id: zod_1.z.string(),
     name: zod_1.z.string(),
-    thumbnailUrl: zod_1.z.string(),
-    imageUrl: zod_1.z.string(),
     order: zod_1.z.number(),
     isDefault: zod_1.z.boolean(),
     devices: zod_1.z.array(exports.sLayoutDeviceDto),
     colorize: zod_1.z.boolean(),
-    map: zod_1.z.boolean(),
+    placementsRev: zod_1.z
+        .number()
+        .int()
+        .describe('Revision of the placements. Send it back when saving devices, to be refused if someone else saved meanwhile.'),
+    map: zod_1.z.boolean().describe('True when kind is map'),
     createdOn: zod_1.z.string(),
     lastModifiedOn: zod_1.z.string(),
 });
+exports.sImageLayoutDto = sLayoutBase.extend({
+    kind: zod_1.z.literal('image'),
+    imageUrl: zod_1.z.string(),
+    thumbnailUrl: zod_1.z.string().optional(),
+});
+exports.sMapLayoutDto = sLayoutBase.extend({
+    kind: zod_1.z.literal('map'),
+    imageUrl: zod_1.z
+        .string()
+        .optional()
+        .describe('Present when the map layout was created with an image'),
+    thumbnailUrl: zod_1.z
+        .string()
+        .optional()
+        .describe('Present when the map layout was created with an image'),
+});
+exports.sModelLayoutDto = sLayoutBase.extend({
+    kind: zod_1.z.literal('3d'),
+});
+exports.sLayoutDto = zod_1.z.discriminatedUnion('kind', [
+    exports.sImageLayoutDto,
+    exports.sMapLayoutDto,
+    exports.sModelLayoutDto,
+]);
+/** The document of a `3d` layout: its model definition and the plan images the definition names. */
+exports.sLayoutModelDto = zod_1.z.object({
+    definition: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+    plans: zod_1.z.array(zod_1.z.object({
+        name: zod_1.z.string().describe('Name the definition refers to the plan by'),
+        url: zod_1.z.string(),
+    })),
+});

package/dist/objects/trackable-retention-policy.d.ts

@@ -6,6 +6,12 @@ export declare const sTrackableRetentionPolicyDto: z.ZodObject<{
         "base-station": "base-station";
         "aid-to-navigation": "aid-to-navigation";
         "sar-aircraft": "sar-aircraft";
+        aircraft: "aircraft";
+        helicopter: "helicopter";
+        glider: "glider";
+        balloon: "balloon";
+        drone: "drone";
+        "ground-vehicle": "ground-vehicle";
     }>>;
     ttlSeconds: z.ZodNumber;
     outOfDateSeconds: z.ZodNumber;