@awarevue/api-types 2.0.148 → 2.0.149

package/dist/api/rest/filter-preset.d.ts

@@ -0,0 +1,24 @@
+import { z } from 'zod';
+export declare const sCreateFilterPresetRequest: z.ZodObject<{
+    target: z.ZodEnum<{
+        "event-history": "event-history";
+    }>;
+    type: z.ZodEnum<{
+        user: "user";
+        global: "global";
+    }>;
+    name: z.ZodString;
+    values: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+}, z.core.$strip>;
+export type CreateFilterPresetRequest = z.infer<typeof sCreateFilterPresetRequest>;
+export declare const sUpdateFilterPresetRequest: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    values: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type UpdateFilterPresetRequest = z.infer<typeof sUpdateFilterPresetRequest>;
+export declare const sFilterPresetQuery: z.ZodObject<{
+    target: z.ZodOptional<z.ZodEnum<{
+        "event-history": "event-history";
+    }>>;
+}, z.core.$strip>;
+export type FilterPresetQuery = z.infer<typeof sFilterPresetQuery>;

package/dist/api/rest/filter-preset.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sFilterPresetQuery = exports.sUpdateFilterPresetRequest = exports.sCreateFilterPresetRequest = void 0;
+const zod_1 = require("zod");
+const filter_preset_1 = require("../../objects/filter-preset");
+const sFilterPresetName = zod_1.z.string().trim().min(1).max(128);
+// Built-in presets are managed by the server and cannot be created through the API
+exports.sCreateFilterPresetRequest = zod_1.z.object({
+    target: filter_preset_1.sFilterPresetTarget,
+    type: zod_1.z.enum(['global', 'user']),
+    name: sFilterPresetName,
+    values: filter_preset_1.sFilterPresetValues,
+});
+// Target and type cannot change after creation
+exports.sUpdateFilterPresetRequest = zod_1.z
+    .object({
+    name: sFilterPresetName,
+    values: filter_preset_1.sFilterPresetValues,
+})
+    .partial();
+exports.sFilterPresetQuery = zod_1.z.object({
+    target: filter_preset_1.sFilterPresetTarget.optional(),
+});

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

@@ -36,3 +36,4 @@ export * from './device';
 export * from './camera';
 export * from './trackables';
 export * from './time-zone';
+export * from './filter-preset';

package/dist/api/rest/index.js

@@ -52,3 +52,4 @@ __exportStar(require("./device"), exports);
 __exportStar(require("./camera"), exports);
 __exportStar(require("./trackables"), exports);
 __exportStar(require("./time-zone"), exports);
+__exportStar(require("./filter-preset"), exports);

package/dist/objects/filter-preset.d.ts

@@ -0,0 +1,31 @@
+import { z } from 'zod';
+export declare const sFilterPresetTarget: z.ZodEnum<{
+    "event-history": "event-history";
+}>;
+export type FilterPresetTarget = z.infer<typeof sFilterPresetTarget>;
+export declare const sFilterPresetType: z.ZodEnum<{
+    user: "user";
+    "built-in": "built-in";
+    global: "global";
+}>;
+export type FilterPresetType = z.infer<typeof sFilterPresetType>;
+export declare const sFilterPresetValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+export type FilterPresetValues = z.infer<typeof sFilterPresetValues>;
+export declare const sFilterPresetDto: z.ZodObject<{
+    id: z.ZodUUID;
+    systemCode: z.ZodNullable<z.ZodString>;
+    target: z.ZodEnum<{
+        "event-history": "event-history";
+    }>;
+    type: z.ZodEnum<{
+        user: "user";
+        "built-in": "built-in";
+        global: "global";
+    }>;
+    name: z.ZodString;
+    values: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    createdBy: z.ZodNullable<z.ZodUUID>;
+    createdOn: z.ZodString;
+    lastModifiedOn: z.ZodString;
+}, z.core.$strip>;
+export type FilterPresetDto = z.infer<typeof sFilterPresetDto>;

package/dist/objects/filter-preset.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sFilterPresetDto = exports.sFilterPresetValues = exports.sFilterPresetType = exports.sFilterPresetTarget = void 0;
+const zod_1 = require("zod");
+// The page whose filter a preset applies to
+exports.sFilterPresetTarget = zod_1.z.enum(['event-history']);
+// built-in = shipped with the server and read-only, global = shared with all users,
+// user = visible to its creator only
+exports.sFilterPresetType = zod_1.z.enum(['built-in', 'global', 'user']);
+// Filter values as the client defines them for the target; the server stores them as-is
+exports.sFilterPresetValues = zod_1.z.record(zod_1.z.string(), zod_1.z.unknown());
+exports.sFilterPresetDto = zod_1.z.object({
+    id: zod_1.z.uuid(),
+    systemCode: zod_1.z.string().nullable(), // Stable identifier of a built-in preset, null otherwise
+    target: exports.sFilterPresetTarget,
+    type: exports.sFilterPresetType,
+    name: zod_1.z.string(),
+    values: exports.sFilterPresetValues,
+    createdBy: zod_1.z.uuid().nullable(), // null for built-in presets
+    createdOn: zod_1.z.string(),
+    lastModifiedOn: zod_1.z.string(),
+});

package/dist/objects/index.d.ts

@@ -28,3 +28,4 @@ export * from './device';
 export * from './module-config';
 export * from './trackable';
 export * from './trackable-retention-policy';
+export * from './filter-preset';

package/dist/objects/index.js

@@ -44,3 +44,4 @@ __exportStar(require("./device"), exports);
 __exportStar(require("./module-config"), exports);
 __exportStar(require("./trackable"), exports);
 __exportStar(require("./trackable-retention-policy"), exports);
+__exportStar(require("./filter-preset"), exports);

package/dist/package.json

@@ -4,7 +4,7 @@
     "type": "git",
     "url": "git+https://github.com/Linc-Security-Systems/aware-essentials.git"
   },
-  "version": "2.0.148",
+  "version": "2.0.149",
   "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.148",
+  "version": "2.0.149",
   "description": "Common types between backend, agent(s) and frontend(s)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",