@awarevue/api-types 2.0.142 → 2.0.143

package/dist/api/agent-protocol/protocol.d.ts

@@ -514,7 +514,12 @@ export declare const sPushTrackableUpdate: z.ZodObject<{
         timestamp: z.ZodNumber;
         objectId: z.ZodString;
         objectName: z.ZodOptional<z.ZodString>;
-        objectKind: z.ZodOptional<z.ZodString>;
+        objectKind: z.ZodOptional<z.ZodEnum<{
+            vessel: "vessel";
+            "base-station": "base-station";
+            "aid-to-navigation": "aid-to-navigation";
+            "sar-aircraft": "sar-aircraft";
+        }>>;
         metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         longitude: z.ZodOptional<z.ZodNumber>;
         latitude: z.ZodOptional<z.ZodNumber>;

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

@@ -1,27 +1,52 @@
 import { z } from 'zod';
 export declare const sTrackableProfileSnapshot: z.ZodObject<{
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
 }, z.core.$strip>;
 export declare const sSetTrackableFavoriteRequest: z.ZodObject<{
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
 }, z.core.$strip>;
 export type SetTrackableFavoriteRequest = z.infer<typeof sSetTrackableFavoriteRequest>;
 export declare const sCreateTrackableRequest: z.ZodObject<{
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
     objectId: z.ZodString;
 }, z.core.$strip>;
 export type CreateTrackableRequest = z.infer<typeof sCreateTrackableRequest>;
 export declare const sUpdateTrackableRequest: z.ZodObject<{
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
 }, z.core.$strip>;
 export type UpdateTrackableRequest = z.infer<typeof sUpdateTrackableRequest>;
 export declare const sAttachTrackableImageRequest: z.ZodObject<{
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
     imageId: z.ZodUUID;
     reviewed: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
@@ -33,7 +58,12 @@ export type SetTrackableImageReviewedRequest = z.infer<typeof sSetTrackableImage
 export declare const sCreateTrackableRetentionPolicyRequest: z.ZodObject<{
     ttlSeconds: z.ZodNumber;
     outOfDateSeconds: z.ZodNumber;
-    objectKind: z.ZodString;
+    objectKind: z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>;
 }, z.core.$strip>;
 export type CreateTrackableRetentionPolicyRequest = z.infer<typeof sCreateTrackableRetentionPolicyRequest>;
 export declare const sUpdateTrackableRetentionPolicyRequest: z.ZodObject<{

package/dist/api/rest/trackables.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sUpdateTrackableRetentionPolicyRequest = exports.sCreateTrackableRetentionPolicyRequest = exports.sSetTrackableImageReviewedRequest = exports.sAttachTrackableImageRequest = exports.sUpdateTrackableRequest = exports.sCreateTrackableRequest = exports.sSetTrackableFavoriteRequest = exports.sTrackableProfileSnapshot = void 0;
 const zod_1 = require("zod");
+const trackable_1 = require("../../objects/trackable");
 exports.sTrackableProfileSnapshot = zod_1.z.object({
     objectName: zod_1.z.string().trim().max(255).optional(),
-    objectKind: zod_1.z.string().trim().max(64).optional(),
+    objectKind: trackable_1.sTrackableKind.optional(),
 });
 exports.sSetTrackableFavoriteRequest = exports.sTrackableProfileSnapshot;
 exports.sCreateTrackableRequest = exports.sTrackableProfileSnapshot.extend({
@@ -29,7 +30,7 @@ const sTrackableRetentionValues = zod_1.z.object({
 });
 // Adds a policy for a specific kind (the default policy always exists)
 exports.sCreateTrackableRetentionPolicyRequest = sTrackableRetentionValues
-    .extend({ objectKind: zod_1.z.string().trim().min(1) })
+    .extend({ objectKind: trackable_1.sTrackableKind })
     .refine(refineRetention, retentionRefineMessage);
 // Replaces both values, so the ttl/out-of-date relationship can be validated
 // here rather than against stored values

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

@@ -4,7 +4,12 @@ export declare const sTrackableUpdate: z.ZodObject<{
     timestamp: z.ZodNumber;
     objectId: z.ZodString;
     objectName: z.ZodOptional<z.ZodString>;
-    objectKind: z.ZodOptional<z.ZodString>;
+    objectKind: z.ZodOptional<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
     metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     longitude: z.ZodOptional<z.ZodNumber>;
     latitude: z.ZodOptional<z.ZodNumber>;
@@ -26,7 +31,12 @@ export declare const sTrackableUpdatePayload: z.ZodObject<{
         timestamp: z.ZodNumber;
         objectId: z.ZodString;
         objectName: z.ZodOptional<z.ZodString>;
-        objectKind: z.ZodOptional<z.ZodString>;
+        objectKind: z.ZodOptional<z.ZodEnum<{
+            vessel: "vessel";
+            "base-station": "base-station";
+            "aid-to-navigation": "aid-to-navigation";
+            "sar-aircraft": "sar-aircraft";
+        }>>;
         metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         longitude: z.ZodOptional<z.ZodNumber>;
         latitude: z.ZodOptional<z.ZodNumber>;

package/dist/api/ws/trackables.js

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.isTrackableMessage = exports.sTrackableRemovePayload = exports.sUnsubscribeTrackablePayload = exports.sSubscribeTrackablePayload = exports.sTrackableUpdatePayload = exports.sTrackableUpdate = void 0;
 const zod_1 = require("zod");
 const primitives_1 = require("../../primitives");
+const trackable_1 = require("../../objects/trackable");
 exports.sTrackableUpdate = zod_1.z.object({
     timestamp: zod_1.z.number(),
     objectId: zod_1.z.string().nonempty(),
     objectName: zod_1.z.string().optional(),
-    objectKind: primitives_1.sWorldObjectId.optional(),
+    objectKind: trackable_1.sTrackableKind.optional(),
     metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
     longitude: zod_1.z.number().min(-180).max(180).optional(),
     latitude: zod_1.z.number().min(-90).max(90).optional(),

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

@@ -1,7 +1,12 @@
 import { z } from 'zod';
 export declare const sTrackableRetentionPolicyDto: z.ZodObject<{
     id: z.ZodUUID;
-    objectKind: z.ZodNullable<z.ZodString>;
+    objectKind: z.ZodNullable<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
     ttlSeconds: z.ZodNumber;
     outOfDateSeconds: z.ZodNumber;
     createdOn: z.ZodString;

package/dist/objects/trackable-retention-policy.js

@@ -2,9 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sTrackableRetentionPolicyDto = void 0;
 const zod_1 = require("zod");
+const trackable_1 = require("./trackable");
 exports.sTrackableRetentionPolicyDto = zod_1.z.object({
     id: zod_1.z.uuid(),
-    objectKind: zod_1.z.string().nullable(), // null = the default policy, used by any kind without its own entry
+    objectKind: trackable_1.sTrackableKind.nullable(), // null = the default policy, used by any kind without its own entry
     ttlSeconds: zod_1.z.number().int().positive(), // Remove the trackable after this long without an update
     outOfDateSeconds: zod_1.z.number().int().positive(), // Show the trackable as out of date (faded) after this long without an update
     createdOn: zod_1.z.string(),

package/dist/objects/trackable.d.ts

@@ -1,4 +1,10 @@
 import { z } from 'zod';
+export declare const sTrackableKind: z.ZodEnum<{
+    vessel: "vessel";
+    "base-station": "base-station";
+    "aid-to-navigation": "aid-to-navigation";
+    "sar-aircraft": "sar-aircraft";
+}>;
 export declare const sTrackableImageDto: z.ZodObject<{
     imageId: z.ZodUUID;
     reviewed: z.ZodBoolean;
@@ -10,7 +16,12 @@ export type TrackableImageDto = z.infer<typeof sTrackableImageDto>;
 export declare const sTrackableProfileDto: z.ZodObject<{
     id: z.ZodString;
     name: z.ZodNullable<z.ZodString>;
-    kind: z.ZodNullable<z.ZodString>;
+    kind: z.ZodNullable<z.ZodEnum<{
+        vessel: "vessel";
+        "base-station": "base-station";
+        "aid-to-navigation": "aid-to-navigation";
+        "sar-aircraft": "sar-aircraft";
+    }>>;
     isUserFavorite: z.ZodBoolean;
     isGlobalFavorite: z.ZodBoolean;
     images: z.ZodArray<z.ZodObject<{

package/dist/objects/trackable.js

@@ -1,7 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sTrackableHistoryDto = exports.sTrackableProfileDto = exports.sTrackableImageDto = void 0;
+exports.sTrackableHistoryDto = exports.sTrackableProfileDto = exports.sTrackableImageDto = exports.sTrackableKind = void 0;
 const zod_1 = require("zod");
+exports.sTrackableKind = zod_1.z.enum([
+    //AIS
+    'vessel',
+    'base-station',
+    'aid-to-navigation',
+    'sar-aircraft',
+]);
 exports.sTrackableImageDto = zod_1.z.object({
     imageId: zod_1.z.uuid(),
     reviewed: zod_1.z.boolean(),
@@ -12,7 +19,7 @@ exports.sTrackableImageDto = zod_1.z.object({
 exports.sTrackableProfileDto = zod_1.z.object({
     id: zod_1.z.string(),
     name: zod_1.z.string().nullable(),
-    kind: zod_1.z.string().nullable(),
+    kind: exports.sTrackableKind.nullable(),
     isUserFavorite: zod_1.z.boolean(),
     isGlobalFavorite: zod_1.z.boolean(),
     images: zod_1.z.array(exports.sTrackableImageDto),

package/dist/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.142",
+  "version": "2.0.143",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.142",
+  "version": "2.0.143",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",