@awarevue/api-types 2.0.12 → 2.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. package/dist/access-control/access-rule.d.ts +6 -6
  2. package/dist/access-control/person.d.ts +6 -6
  3. package/dist/access-control/schedule.d.ts +2 -2
  4. package/dist/access-control/zone.d.ts +4 -4
  5. package/dist/agent-communication/index.d.ts +0 -1
  6. package/dist/agent-communication/index.js +0 -1
  7. package/dist/agent-communication/protocol.d.ts +170 -170
  8. package/dist/alarm-automation.d.ts +1 -1
  9. package/dist/api/alarm.d.ts +1 -1
  10. package/dist/api/media.d.ts +8 -8
  11. package/dist/bookmarks.d.ts +2 -2
  12. package/dist/cast.d.ts +2 -2
  13. package/dist/commands/alarm.d.ts +312 -0
  14. package/dist/commands/alarm.js +62 -0
  15. package/dist/{device-command.d.ts → commands/all.d.ts} +23 -25
  16. package/dist/{device-command.js → commands/all.js} +9 -9
  17. package/dist/commands/camera-lift.d.ts +46 -0
  18. package/dist/commands/camera-lift.js +17 -0
  19. package/dist/commands/camera.d.ts +478 -0
  20. package/dist/commands/camera.js +97 -0
  21. package/dist/commands/display.d.ts +431 -0
  22. package/dist/commands/display.js +37 -0
  23. package/dist/commands/door.d.ts +88 -0
  24. package/dist/commands/door.js +27 -0
  25. package/dist/commands/index.d.ts +12 -0
  26. package/dist/commands/index.js +28 -0
  27. package/dist/commands/intercom-terminal.d.ts +40 -0
  28. package/dist/{device/reader/commands.js → commands/intercom-terminal.js} +1 -0
  29. package/dist/commands/io-board.d.ts +55 -0
  30. package/dist/commands/io-board.js +15 -0
  31. package/dist/commands/nvr-exporter.d.ts +1262 -0
  32. package/dist/commands/nvr-exporter.js +26 -0
  33. package/dist/commands/pbx.d.ts +75 -0
  34. package/dist/commands/pbx.js +17 -0
  35. package/dist/commands/presence-tracker.d.ts +167 -0
  36. package/dist/commands/presence-tracker.js +33 -0
  37. package/dist/commands/server.d.ts +1272 -0
  38. package/dist/commands/server.js +27 -0
  39. package/dist/device/alarm.d.ts +0 -530
  40. package/dist/device/alarm.js +1 -110
  41. package/dist/device/any-device.d.ts +88 -88
  42. package/dist/device/camera-lift.d.ts +0 -45
  43. package/dist/device/camera-lift.js +1 -14
  44. package/dist/device/camera.d.ts +0 -1248
  45. package/dist/device/camera.js +1 -204
  46. package/dist/device/device-gateway.d.ts +0 -2
  47. package/dist/device/device-gateway.js +1 -0
  48. package/dist/device/display.d.ts +0 -438
  49. package/dist/device/display.js +1 -39
  50. package/dist/device/door.d.ts +0 -306
  51. package/dist/device/door.js +1 -82
  52. package/dist/device/index.d.ts +1 -1
  53. package/dist/device/index.js +1 -1
  54. package/dist/device/intercom-operator.js +0 -1
  55. package/dist/device/intercom-terminal.d.ts +0 -101
  56. package/dist/device/intercom-terminal.js +3 -55
  57. package/dist/device/io-board.d.ts +0 -84
  58. package/dist/device/io-board.js +1 -21
  59. package/dist/device/motion-sensor.js +0 -1
  60. package/dist/device/nvr-analytics-server.d.ts +0 -295
  61. package/dist/device/nvr-analytics-server.js +1 -65
  62. package/dist/device/nvr-exporter.d.ts +0 -1436
  63. package/dist/device/nvr-exporter.js +1 -72
  64. package/dist/device/nvr-recorder.d.ts +0 -2633
  65. package/dist/device/nvr-recorder.js +1 -39
  66. package/dist/device/panic-button.d.ts +0 -18
  67. package/dist/device/panic-button.js +1 -8
  68. package/dist/device/pbx.d.ts +0 -74
  69. package/dist/device/pbx.js +1 -16
  70. package/dist/device/presence-tracker.d.ts +0 -302
  71. package/dist/device/presence-tracker.js +1 -59
  72. package/dist/device/server.d.ts +0 -200
  73. package/dist/device/server.js +1 -37
  74. package/dist/device/system.d.ts +0 -42
  75. package/dist/device/system.js +1 -13
  76. package/dist/device-event.d.ts +1 -721
  77. package/dist/device-event.js +0 -110
  78. package/dist/device-group.d.ts +2 -2
  79. package/dist/device-import.d.ts +8 -8
  80. package/dist/events/alarm.d.ts +220 -0
  81. package/dist/events/alarm.js +55 -0
  82. package/dist/events/all.d.ts +700 -0
  83. package/dist/events/all.js +109 -0
  84. package/dist/events/camera.d.ts +661 -0
  85. package/dist/events/camera.js +87 -0
  86. package/dist/events/display.d.ts +9 -0
  87. package/dist/events/display.js +9 -0
  88. package/dist/events/door.d.ts +220 -0
  89. package/dist/events/door.js +62 -0
  90. package/dist/events/index.d.ts +12 -0
  91. package/dist/events/index.js +28 -0
  92. package/dist/events/intercom-terminal.d.ts +61 -0
  93. package/dist/events/intercom-terminal.js +19 -0
  94. package/dist/events/io-board.d.ts +31 -0
  95. package/dist/events/io-board.js +13 -0
  96. package/dist/events/nvr-exporter.d.ts +52 -0
  97. package/dist/events/nvr-exporter.js +21 -0
  98. package/dist/events/panic-button.d.ts +19 -0
  99. package/dist/events/panic-button.js +11 -0
  100. package/dist/events/presence-tracker.d.ts +136 -0
  101. package/dist/events/presence-tracker.js +33 -0
  102. package/dist/events/server.d.ts +65 -0
  103. package/dist/events/server.js +15 -0
  104. package/dist/index.d.ts +4 -1
  105. package/dist/index.js +4 -1
  106. package/dist/layout.d.ts +8 -8
  107. package/dist/macros.d.ts +14 -14
  108. package/dist/messages/device-communication.d.ts +2 -2
  109. package/dist/messages/notifications.d.ts +2 -2
  110. package/dist/messages/web-rtc-signaling.d.ts +10 -10
  111. package/dist/notifications.d.ts +4 -4
  112. package/dist/package.json +1 -1
  113. package/dist/primitives.d.ts +20 -2
  114. package/dist/primitives.js +19 -3
  115. package/dist/{agent-communication/queries.d.ts → queries/all.d.ts} +24 -22
  116. package/dist/queries/all.js +21 -0
  117. package/dist/queries/camera.d.ts +98 -0
  118. package/dist/queries/camera.js +27 -0
  119. package/dist/queries/index.d.ts +5 -0
  120. package/dist/{device/reader → queries}/index.js +5 -3
  121. package/dist/queries/nvr-analytics-server.d.ts +296 -0
  122. package/dist/queries/nvr-analytics-server.js +68 -0
  123. package/dist/queries/nvr-exporter.d.ts +125 -0
  124. package/dist/queries/nvr-exporter.js +36 -0
  125. package/dist/queries/nvr-recorder.d.ts +2634 -0
  126. package/dist/queries/nvr-recorder.js +42 -0
  127. package/dist/user.d.ts +4 -4
  128. package/package.json +1 -1
  129. package/dist/agent-communication/queries.js +0 -19
  130. package/dist/device/reader/commands.d.ts +0 -1
  131. package/dist/device/reader/index.d.ts +0 -3
  132. /package/dist/device/{reader/specs.d.ts → reader.d.ts} +0 -0
  133. /package/dist/device/{reader/specs.js → reader.js} +0 -0
  134. /package/dist/{device/reader/events.d.ts → events/reader.d.ts} +0 -0
  135. /package/dist/{device/reader/events.js → events/reader.js} +0 -0
@@ -0,0 +1,68 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.nvrAnalyticsResponseSchemas = exports.nvrAnalyticsRequestSchemas = exports.sObjectThumbnailResponse = exports.sObjectThumbnailArgs = exports.QUERY_OBJECT_THUMBNAIL = exports.sObjectSnapshotResponse = exports.sObjectSnapshotArgs = exports.QUERY_OBJECT_SNAPSHOT = exports.sScenePreviewClipResponse = exports.sScenePreviewClipArgs = exports.QUERY_SCENE_PREVIEW_CLIP = exports.sMediaSearchResponse = exports.sMediaSearchMatch = exports.sMediaSearchArgs = exports.QUERY_MEDIA_SEARCH = void 0;
4
+ const zod_1 = require("zod");
5
+ const primitives_1 = require("../primitives");
6
+ const api_1 = require("../api");
7
+ // QUERIES
8
+ // -- Media Search
9
+ exports.QUERY_MEDIA_SEARCH = 'cctv:media-search';
10
+ exports.sMediaSearchArgs = zod_1.z
11
+ .object({
12
+ devices: zod_1.z.array(zod_1.z.any()).optional(),
13
+ limit: zod_1.z.number().nonnegative(),
14
+ q: zod_1.z.string(),
15
+ similarTo: zod_1.z.string().optional(),
16
+ label: zod_1.z.array(zod_1.z.string().nonempty()),
17
+ timeFrom: zod_1.z.number().nonnegative(),
18
+ timeTo: zod_1.z.number().nonnegative(),
19
+ sortBy: api_1.sSortOptions,
20
+ })
21
+ .partial();
22
+ exports.sMediaSearchMatch = zod_1.z.object({
23
+ relevance: zod_1.z.number(),
24
+ providerAssignedRef: zod_1.z.string(),
25
+ foreignRef: zod_1.z.string(),
26
+ provider: zod_1.z.string(),
27
+ probability: zod_1.z.number(),
28
+ objectKind: zod_1.z.string(),
29
+ startTime: zod_1.z.number(),
30
+ endTime: zod_1.z.number().nullable(),
31
+ });
32
+ exports.sMediaSearchResponse = zod_1.z.array(exports.sMediaSearchMatch);
33
+ // -- Scene Preview Clip
34
+ exports.QUERY_SCENE_PREVIEW_CLIP = 'cctv:scene-preview-clip';
35
+ exports.sScenePreviewClipArgs = zod_1.z.object({
36
+ providerAssignedRef: zod_1.z.string(),
37
+ });
38
+ exports.sScenePreviewClipResponse = primitives_1.sFileResponse;
39
+ // -- Object Snapshot
40
+ exports.QUERY_OBJECT_SNAPSHOT = 'cctv:object-snapshot';
41
+ exports.sObjectSnapshotArgs = zod_1.z.object({
42
+ providerAssignedRef: zod_1.z.string(),
43
+ height: zod_1.z.number().optional(),
44
+ quality: zod_1.z.number().optional(),
45
+ crop: zod_1.z.boolean(),
46
+ boxes: zod_1.z.boolean(),
47
+ });
48
+ exports.sObjectSnapshotResponse = primitives_1.sFileResponse;
49
+ // -- Object Thumbnail
50
+ exports.QUERY_OBJECT_THUMBNAIL = 'cctv:object-thumbnail';
51
+ exports.sObjectThumbnailArgs = zod_1.z.object({
52
+ providerAssignedRef: zod_1.z.string(),
53
+ });
54
+ exports.sObjectThumbnailResponse = primitives_1.sFileResponse;
55
+ // Dictionary of request schemas by query type
56
+ exports.nvrAnalyticsRequestSchemas = {
57
+ [exports.QUERY_MEDIA_SEARCH]: exports.sMediaSearchArgs,
58
+ [exports.QUERY_SCENE_PREVIEW_CLIP]: exports.sScenePreviewClipArgs,
59
+ [exports.QUERY_OBJECT_SNAPSHOT]: exports.sObjectSnapshotArgs,
60
+ [exports.QUERY_OBJECT_THUMBNAIL]: exports.sObjectThumbnailArgs,
61
+ };
62
+ // Dictionary of response schemas by query type
63
+ exports.nvrAnalyticsResponseSchemas = {
64
+ [exports.QUERY_MEDIA_SEARCH]: exports.sMediaSearchResponse,
65
+ [exports.QUERY_SCENE_PREVIEW_CLIP]: exports.sScenePreviewClipResponse,
66
+ [exports.QUERY_OBJECT_SNAPSHOT]: exports.sObjectSnapshotResponse,
67
+ [exports.QUERY_OBJECT_THUMBNAIL]: exports.sObjectThumbnailResponse,
68
+ };
@@ -0,0 +1,125 @@
1
+ import { z } from 'zod';
2
+ export declare const QUERY_GET_EXPORT_LINK = "cctv:get-export-link";
3
+ export declare const sGetExportLinkArgs: z.ZodObject<{
4
+ exportId: z.ZodString;
5
+ }, "strip", z.ZodTypeAny, {
6
+ exportId: string;
7
+ }, {
8
+ exportId: string;
9
+ }>;
10
+ export declare const sGetExportLinkResponse: z.ZodObject<{
11
+ exportLink: z.ZodString;
12
+ }, "strip", z.ZodTypeAny, {
13
+ exportLink: string;
14
+ }, {
15
+ exportLink: string;
16
+ }>;
17
+ export type GetExportLinkArgs = z.infer<typeof sGetExportLinkArgs>;
18
+ export type GetExportLinkResponse = z.infer<typeof sGetExportLinkResponse>;
19
+ export declare const QUERY_GET_EXPORTS = "cctv:get-exports";
20
+ export declare const sGetExportsArgs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
21
+ export declare const sExportItem: z.ZodObject<{
22
+ name: z.ZodString;
23
+ endTime: z.ZodNumber;
24
+ startTime: z.ZodNumber;
25
+ id: z.ZodString;
26
+ status: z.ZodString;
27
+ size: z.ZodOptional<z.ZodString>;
28
+ expires: z.ZodOptional<z.ZodNumber>;
29
+ }, "strip", z.ZodTypeAny, {
30
+ name: string;
31
+ endTime: number;
32
+ startTime: number;
33
+ id: string;
34
+ status: string;
35
+ size?: string | undefined;
36
+ expires?: number | undefined;
37
+ }, {
38
+ name: string;
39
+ endTime: number;
40
+ startTime: number;
41
+ id: string;
42
+ status: string;
43
+ size?: string | undefined;
44
+ expires?: number | undefined;
45
+ }>;
46
+ export declare const sGetExportsResponse: z.ZodArray<z.ZodObject<{
47
+ name: z.ZodString;
48
+ endTime: z.ZodNumber;
49
+ startTime: z.ZodNumber;
50
+ id: z.ZodString;
51
+ status: z.ZodString;
52
+ size: z.ZodOptional<z.ZodString>;
53
+ expires: z.ZodOptional<z.ZodNumber>;
54
+ }, "strip", z.ZodTypeAny, {
55
+ name: string;
56
+ endTime: number;
57
+ startTime: number;
58
+ id: string;
59
+ status: string;
60
+ size?: string | undefined;
61
+ expires?: number | undefined;
62
+ }, {
63
+ name: string;
64
+ endTime: number;
65
+ startTime: number;
66
+ id: string;
67
+ status: string;
68
+ size?: string | undefined;
69
+ expires?: number | undefined;
70
+ }>, "many">;
71
+ export type GetExportsArgs = z.infer<typeof sGetExportsArgs>;
72
+ export type ExportItem = z.infer<typeof sExportItem>;
73
+ export type GetExportsResponse = z.infer<typeof sGetExportsResponse>;
74
+ export declare const nvrExporterRequestSchemas: {
75
+ readonly "cctv:get-export-link": z.ZodObject<{
76
+ exportId: z.ZodString;
77
+ }, "strip", z.ZodTypeAny, {
78
+ exportId: string;
79
+ }, {
80
+ exportId: string;
81
+ }>;
82
+ readonly "cctv:get-exports": z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
83
+ };
84
+ export declare const nvrExporterResponseSchemas: {
85
+ readonly "cctv:get-export-link": z.ZodObject<{
86
+ exportLink: z.ZodString;
87
+ }, "strip", z.ZodTypeAny, {
88
+ exportLink: string;
89
+ }, {
90
+ exportLink: string;
91
+ }>;
92
+ readonly "cctv:get-exports": z.ZodArray<z.ZodObject<{
93
+ name: z.ZodString;
94
+ endTime: z.ZodNumber;
95
+ startTime: z.ZodNumber;
96
+ id: z.ZodString;
97
+ status: z.ZodString;
98
+ size: z.ZodOptional<z.ZodString>;
99
+ expires: z.ZodOptional<z.ZodNumber>;
100
+ }, "strip", z.ZodTypeAny, {
101
+ name: string;
102
+ endTime: number;
103
+ startTime: number;
104
+ id: string;
105
+ status: string;
106
+ size?: string | undefined;
107
+ expires?: number | undefined;
108
+ }, {
109
+ name: string;
110
+ endTime: number;
111
+ startTime: number;
112
+ id: string;
113
+ status: string;
114
+ size?: string | undefined;
115
+ expires?: number | undefined;
116
+ }>, "many">;
117
+ };
118
+ export type NvrExporterQueryRequestMap = {
119
+ [QUERY_GET_EXPORT_LINK]: GetExportLinkArgs;
120
+ [QUERY_GET_EXPORTS]: GetExportsArgs;
121
+ };
122
+ export type NvrExporterQueryResponseMap = {
123
+ [QUERY_GET_EXPORT_LINK]: GetExportLinkResponse;
124
+ [QUERY_GET_EXPORTS]: GetExportsResponse;
125
+ };
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.nvrExporterResponseSchemas = exports.nvrExporterRequestSchemas = exports.sGetExportsResponse = exports.sExportItem = exports.sGetExportsArgs = exports.QUERY_GET_EXPORTS = exports.sGetExportLinkResponse = exports.sGetExportLinkArgs = exports.QUERY_GET_EXPORT_LINK = void 0;
4
+ const zod_1 = require("zod");
5
+ // QUERIES
6
+ // -- Get Export Link
7
+ exports.QUERY_GET_EXPORT_LINK = 'cctv:get-export-link';
8
+ exports.sGetExportLinkArgs = zod_1.z.object({
9
+ exportId: zod_1.z.string().nonempty(),
10
+ });
11
+ exports.sGetExportLinkResponse = zod_1.z.object({
12
+ exportLink: zod_1.z.string().url(),
13
+ });
14
+ // -- Get Exports
15
+ exports.QUERY_GET_EXPORTS = 'cctv:get-exports';
16
+ exports.sGetExportsArgs = zod_1.z.object({});
17
+ exports.sExportItem = zod_1.z.object({
18
+ name: zod_1.z.string().nonempty(),
19
+ endTime: zod_1.z.number().int().nonnegative(),
20
+ startTime: zod_1.z.number().int().nonnegative(),
21
+ id: zod_1.z.string().nonempty(),
22
+ status: zod_1.z.string().nonempty(),
23
+ size: zod_1.z.string().nonempty().optional(),
24
+ expires: zod_1.z.number().int().nonnegative().optional(),
25
+ });
26
+ exports.sGetExportsResponse = zod_1.z.array(exports.sExportItem);
27
+ // Dictionary of request schemas by query type
28
+ exports.nvrExporterRequestSchemas = {
29
+ [exports.QUERY_GET_EXPORT_LINK]: exports.sGetExportLinkArgs,
30
+ [exports.QUERY_GET_EXPORTS]: exports.sGetExportsArgs,
31
+ };
32
+ // Dictionary of response schemas by query type
33
+ exports.nvrExporterResponseSchemas = {
34
+ [exports.QUERY_GET_EXPORT_LINK]: exports.sGetExportLinkResponse,
35
+ [exports.QUERY_GET_EXPORTS]: exports.sGetExportsResponse,
36
+ };