@awarevue/api-types 2.0.141 → 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>;
@@ -30,3 +55,19 @@ export declare const sSetTrackableImageReviewedRequest: z.ZodObject<{
     reviewed: z.ZodBoolean;
 }, z.core.$strip>;
 export type SetTrackableImageReviewedRequest = z.infer<typeof sSetTrackableImageReviewedRequest>;
+export declare const sCreateTrackableRetentionPolicyRequest: z.ZodObject<{
+    ttlSeconds: z.ZodNumber;
+    outOfDateSeconds: z.ZodNumber;
+    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<{
+    ttlSeconds: z.ZodNumber;
+    outOfDateSeconds: z.ZodNumber;
+}, z.core.$strip>;
+export type UpdateTrackableRetentionPolicyRequest = z.infer<typeof sUpdateTrackableRetentionPolicyRequest>;

package/dist/api/rest/trackables.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sSetTrackableImageReviewedRequest = exports.sAttachTrackableImageRequest = exports.sUpdateTrackableRequest = exports.sCreateTrackableRequest = exports.sSetTrackableFavoriteRequest = exports.sTrackableProfileSnapshot = void 0;
+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({
@@ -18,3 +19,19 @@ exports.sAttachTrackableImageRequest = exports.sTrackableProfileSnapshot.extend(
 exports.sSetTrackableImageReviewedRequest = zod_1.z.object({
     reviewed: zod_1.z.boolean(),
 });
+const refineRetention = (v) => v.outOfDateSeconds < v.ttlSeconds;
+const retentionRefineMessage = {
+    message: 'outOfDateSeconds must be less than ttlSeconds',
+    path: ['outOfDateSeconds'],
+};
+const sTrackableRetentionValues = zod_1.z.object({
+    ttlSeconds: zod_1.z.number().int().positive(),
+    outOfDateSeconds: zod_1.z.number().int().positive(),
+});
+// Adds a policy for a specific kind (the default policy always exists)
+exports.sCreateTrackableRetentionPolicyRequest = sTrackableRetentionValues
+    .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
+exports.sUpdateTrackableRetentionPolicyRequest = sTrackableRetentionValues.refine(refineRetention, retentionRefineMessage);

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>;
@@ -48,10 +58,15 @@ export declare const sSubscribeTrackablePayload: z.ZodObject<{}, z.core.$strip>;
 export type SubscribeTrackablePayload = z.infer<typeof sSubscribeTrackablePayload>;
 export declare const sUnsubscribeTrackablePayload: z.ZodObject<{}, z.core.$strip>;
 export type UnsubscribeTrackablePayload = z.infer<typeof sUnsubscribeTrackablePayload>;
+export declare const sTrackableRemovePayload: z.ZodObject<{
+    objectIds: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type TrackableRemovePayload = z.infer<typeof sTrackableRemovePayload>;
 interface TrackableMessageMap {
     subscribe: SubscribeTrackablePayload;
     unsubscribe: UnsubscribeTrackablePayload;
     update: TrackableUpdatePayload;
+    remove: TrackableRemovePayload;
 }
 export type TrackableWsMessage = {
     [K in keyof TrackableMessageMap]: {

package/dist/api/ws/trackables.js

@@ -1,13 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTrackableMessage = exports.sUnsubscribeTrackablePayload = exports.sSubscribeTrackablePayload = exports.sTrackableUpdatePayload = exports.sTrackableUpdate = void 0;
+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(),
@@ -20,10 +21,14 @@ exports.sTrackableUpdatePayload = zod_1.z.object({
 });
 exports.sSubscribeTrackablePayload = zod_1.z.object({});
 exports.sUnsubscribeTrackablePayload = zod_1.z.object({});
+exports.sTrackableRemovePayload = zod_1.z.object({
+    objectIds: zod_1.z.array(zod_1.z.string()),
+});
 const validators = {
     subscribe: exports.sSubscribeTrackablePayload,
     unsubscribe: exports.sUnsubscribeTrackablePayload,
     update: exports.sTrackableUpdatePayload,
+    remove: exports.sTrackableRemovePayload,
 };
 const isTrackableMessage = (message) => {
     const validator = validators[message.event];

package/dist/objects/all.d.ts

@@ -18,6 +18,7 @@ import { UserDto } from './user';
 import { ViewDto } from './view';
 import { ZoneDto, ZoneProps } from './zone';
 import { TrackableProfileDto } from './trackable';
+import { TrackableRetentionPolicyDto } from './trackable-retention-policy';
 export declare const sObjectKind: z.ZodEnum<{
     accessRule: "accessRule";
     schedule: "schedule";
@@ -38,6 +39,7 @@ export declare const sObjectKind: z.ZodEnum<{
     securityLevel: "securityLevel";
     personType: "personType";
     apiKey: "apiKey";
+    trackableRetentionPolicy: "trackableRetentionPolicy";
 }>;
 export type ObjectKind = z.infer<typeof sObjectKind>;
 export type ObjectKinds = {
@@ -60,6 +62,7 @@ export type ObjectKinds = {
     agreement: AgreementDto;
     apiKey: ApiKeyDto;
     trackable: TrackableProfileDto;
+    trackableRetentionPolicy: TrackableRetentionPolicyDto;
 };
 export type ObjectDto = ObjectKinds;
 export type ObjectProps = {

package/dist/objects/all.js

@@ -22,6 +22,7 @@ exports.sObjectKind = zod_1.z.enum([
     'agreement',
     'apiKey',
     'trackable',
+    'trackableRetentionPolicy',
 ]);
 exports.objectLabels = {
     accessRule: 'Access Rule',
@@ -43,5 +44,6 @@ exports.objectLabels = {
     agreement: 'Agreement',
     apiKey: 'API Key',
     trackable: 'Trackable Profile',
+    trackableRetentionPolicy: 'Trackable Retention Policy',
 };
 exports.objectKinds = exports.sObjectKind.options;

package/dist/objects/index.d.ts

@@ -27,3 +27,4 @@ export * from './world-object';
 export * from './device';
 export * from './module-config';
 export * from './trackable';
+export * from './trackable-retention-policy';

package/dist/objects/index.js

@@ -43,3 +43,4 @@ __exportStar(require("./world-object"), exports);
 __exportStar(require("./device"), exports);
 __exportStar(require("./module-config"), exports);
 __exportStar(require("./trackable"), exports);
+__exportStar(require("./trackable-retention-policy"), exports);

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

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+export declare const sTrackableRetentionPolicyDto: z.ZodObject<{
+    id: z.ZodUUID;
+    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;
+    lastModifiedOn: z.ZodString;
+}, z.core.$strip>;
+export type TrackableRetentionPolicyDto = z.infer<typeof sTrackableRetentionPolicyDto>;

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

@@ -0,0 +1,13 @@
+"use strict";
+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: 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(),
+    lastModifiedOn: 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.141",
+  "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.141",
+  "version": "2.0.143",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",