@awarevue/api-types 1.0.1

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 (132) hide show
  1. package/dist/access-control/access-rule.d.ts +243 -0
  2. package/dist/access-control/access-rule.js +49 -0
  3. package/dist/access-control/credential.d.ts +14 -0
  4. package/dist/access-control/credential.js +12 -0
  5. package/dist/access-control/index.d.ts +7 -0
  6. package/dist/access-control/index.js +23 -0
  7. package/dist/access-control/person-presence.d.ts +249 -0
  8. package/dist/access-control/person-presence.js +61 -0
  9. package/dist/access-control/person.d.ts +209 -0
  10. package/dist/access-control/person.js +49 -0
  11. package/dist/access-control/schedule.d.ts +500 -0
  12. package/dist/access-control/schedule.js +65 -0
  13. package/dist/access-control/sync.d.ts +3 -0
  14. package/dist/access-control/sync.js +2 -0
  15. package/dist/access-control/zone.d.ts +65 -0
  16. package/dist/access-control/zone.js +28 -0
  17. package/dist/agent-communication/index.d.ts +1 -0
  18. package/dist/agent-communication/index.js +17 -0
  19. package/dist/agent-communication/protocol.d.ts +1692 -0
  20. package/dist/agent-communication/protocol.js +341 -0
  21. package/dist/api/alarm.d.ts +23 -0
  22. package/dist/api/alarm.js +2 -0
  23. package/dist/api/auth.d.ts +31 -0
  24. package/dist/api/auth.js +19 -0
  25. package/dist/api/index.d.ts +4 -0
  26. package/dist/api/index.js +20 -0
  27. package/dist/api/media.d.ts +187 -0
  28. package/dist/api/media.js +59 -0
  29. package/dist/api/query.d.ts +33 -0
  30. package/dist/api/query.js +41 -0
  31. package/dist/app.d.ts +12 -0
  32. package/dist/app.js +8 -0
  33. package/dist/automation.d.ts +334 -0
  34. package/dist/automation.js +49 -0
  35. package/dist/aware-config.d.ts +3 -0
  36. package/dist/aware-config.js +2 -0
  37. package/dist/custom-field.d.ts +52 -0
  38. package/dist/custom-field.js +19 -0
  39. package/dist/device/alarm.d.ts +265 -0
  40. package/dist/device/alarm.js +66 -0
  41. package/dist/device/any-device.d.ts +2376 -0
  42. package/dist/device/any-device.js +185 -0
  43. package/dist/device/camera-lift.d.ts +17 -0
  44. package/dist/device/camera-lift.js +7 -0
  45. package/dist/device/camera.d.ts +829 -0
  46. package/dist/device/camera.js +120 -0
  47. package/dist/device/device-gateway.d.ts +3 -0
  48. package/dist/device/device-gateway.js +4 -0
  49. package/dist/device/door.d.ts +217 -0
  50. package/dist/device/door.js +57 -0
  51. package/dist/device/index.d.ts +15 -0
  52. package/dist/device/index.js +31 -0
  53. package/dist/device/intercom-operator.d.ts +13 -0
  54. package/dist/device/intercom-operator.js +5 -0
  55. package/dist/device/intercom-terminal.d.ts +244 -0
  56. package/dist/device/intercom-terminal.js +48 -0
  57. package/dist/device/io-board.d.ts +55 -0
  58. package/dist/device/io-board.js +19 -0
  59. package/dist/device/motion-sensor.d.ts +8 -0
  60. package/dist/device/motion-sensor.js +8 -0
  61. package/dist/device/panic-button.d.ts +26 -0
  62. package/dist/device/panic-button.js +14 -0
  63. package/dist/device/pbx.d.ts +20 -0
  64. package/dist/device/pbx.js +11 -0
  65. package/dist/device/presence-tracker.d.ts +127 -0
  66. package/dist/device/presence-tracker.js +27 -0
  67. package/dist/device/reader/commands.d.ts +1 -0
  68. package/dist/device/reader/commands.js +2 -0
  69. package/dist/device/reader/events.d.ts +37 -0
  70. package/dist/device/reader/events.js +13 -0
  71. package/dist/device/reader/index.d.ts +3 -0
  72. package/dist/device/reader/index.js +19 -0
  73. package/dist/device/reader/specs.d.ts +2 -0
  74. package/dist/device/reader/specs.js +4 -0
  75. package/dist/device/server.d.ts +73 -0
  76. package/dist/device/server.js +33 -0
  77. package/dist/device-command.d.ts +23 -0
  78. package/dist/device-command.js +110 -0
  79. package/dist/device-event.d.ts +682 -0
  80. package/dist/device-event.js +87 -0
  81. package/dist/device-factory.d.ts +112 -0
  82. package/dist/device-factory.js +25 -0
  83. package/dist/device-group.d.ts +74 -0
  84. package/dist/device-group.js +31 -0
  85. package/dist/device-import.d.ts +1412 -0
  86. package/dist/device-import.js +33 -0
  87. package/dist/device-relation.d.ts +30 -0
  88. package/dist/device-relation.js +68 -0
  89. package/dist/device-state.d.ts +10 -0
  90. package/dist/device-state.js +2 -0
  91. package/dist/error.d.ts +13 -0
  92. package/dist/error.js +10 -0
  93. package/dist/file.d.ts +3 -0
  94. package/dist/file.js +2 -0
  95. package/dist/index.d.ts +28 -0
  96. package/dist/index.js +44 -0
  97. package/dist/layout.d.ts +188 -0
  98. package/dist/layout.js +40 -0
  99. package/dist/macros.d.ts +160 -0
  100. package/dist/macros.js +26 -0
  101. package/dist/messages/device-communication.d.ts +121 -0
  102. package/dist/messages/device-communication.js +63 -0
  103. package/dist/messages/index.d.ts +5 -0
  104. package/dist/messages/index.js +21 -0
  105. package/dist/messages/progress.d.ts +118 -0
  106. package/dist/messages/progress.js +51 -0
  107. package/dist/messages/provider-api/index.d.ts +1 -0
  108. package/dist/messages/provider-api/index.js +17 -0
  109. package/dist/messages/provider-api/sync-protocol.d.ts +83 -0
  110. package/dist/messages/provider-api/sync-protocol.js +2 -0
  111. package/dist/messages/web-rtc-signaling.d.ts +265 -0
  112. package/dist/messages/web-rtc-signaling.js +82 -0
  113. package/dist/messages/web-socket.d.ts +7 -0
  114. package/dist/messages/web-socket.js +5 -0
  115. package/dist/milestone.d.ts +5 -0
  116. package/dist/milestone.js +2 -0
  117. package/dist/module-config.d.ts +27 -0
  118. package/dist/module-config.js +2 -0
  119. package/dist/orchid.d.ts +19 -0
  120. package/dist/orchid.js +2 -0
  121. package/dist/package.json +40 -0
  122. package/dist/permissions.d.ts +6 -0
  123. package/dist/permissions.js +168 -0
  124. package/dist/template.d.ts +50 -0
  125. package/dist/template.js +21 -0
  126. package/dist/user.d.ts +184 -0
  127. package/dist/user.js +56 -0
  128. package/dist/view.d.ts +775 -0
  129. package/dist/view.js +74 -0
  130. package/dist/webrtc-playback.d.ts +20 -0
  131. package/dist/webrtc-playback.js +14 -0
  132. package/package.json +40 -0
package/dist/view.js ADDED
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.sViewDto = exports.sViewInfo = exports.sUpdateViewRequest = exports.sAddViewRequest = exports.sViewConfig = exports.sViewAreaContents = exports.sDeviceCarouselArea = exports.sDeviceArea = exports.sLayoutSelectorArea = exports.sLayoutArea = void 0;
7
+ const zod_1 = __importDefault(require("zod"));
8
+ exports.sLayoutArea = zod_1.default.object({
9
+ area: zod_1.default.string().nonempty(),
10
+ type: zod_1.default.literal('layout'),
11
+ layoutId: zod_1.default.string().nonempty(),
12
+ });
13
+ exports.sLayoutSelectorArea = zod_1.default.object({
14
+ area: zod_1.default.string().nonempty(),
15
+ type: zod_1.default.literal('layoutSelector'),
16
+ });
17
+ exports.sDeviceArea = zod_1.default.object({
18
+ area: zod_1.default.string().nonempty(),
19
+ type: zod_1.default.literal('device'),
20
+ deviceId: zod_1.default.string().nonempty(),
21
+ });
22
+ exports.sDeviceCarouselArea = zod_1.default.object({
23
+ area: zod_1.default.string().nonempty(),
24
+ type: zod_1.default.literal('deviceCarousel'),
25
+ deviceIds: zod_1.default.array(zod_1.default.string().nonempty()),
26
+ timeIntervalMs: zod_1.default.number().nonnegative(),
27
+ });
28
+ exports.sViewAreaContents = zod_1.default.union([
29
+ exports.sLayoutArea,
30
+ exports.sLayoutSelectorArea,
31
+ exports.sDeviceArea,
32
+ exports.sDeviceCarouselArea,
33
+ ]);
34
+ exports.sViewConfig = zod_1.default.object({
35
+ rows: zod_1.default.number(),
36
+ columns: zod_1.default.number(),
37
+ areas: zod_1.default.array(zod_1.default.array(zod_1.default.string().nonempty())),
38
+ hotspotArea: zod_1.default.string().optional(),
39
+ contents: zod_1.default.array(exports.sViewAreaContents),
40
+ });
41
+ exports.sAddViewRequest = zod_1.default.object({
42
+ name: zod_1.default.string().nonempty(),
43
+ order: zod_1.default.number().optional(),
44
+ isPublic: zod_1.default.boolean(),
45
+ isDefault: zod_1.default.boolean().optional(),
46
+ config: exports.sViewConfig,
47
+ });
48
+ exports.sUpdateViewRequest = zod_1.default.object({
49
+ name: zod_1.default.string().optional(),
50
+ order: zod_1.default.number().optional(),
51
+ isPublic: zod_1.default.boolean().optional(),
52
+ isDefault: zod_1.default.boolean().optional(),
53
+ config: exports.sViewConfig.optional(),
54
+ });
55
+ exports.sViewInfo = zod_1.default
56
+ .object({
57
+ name: zod_1.default.string(),
58
+ order: zod_1.default.number(),
59
+ isPublic: zod_1.default.boolean(),
60
+ isDefault: zod_1.default.boolean(),
61
+ })
62
+ .and(exports.sViewConfig);
63
+ exports.sViewDto = zod_1.default
64
+ .object({
65
+ id: zod_1.default.string(),
66
+ name: zod_1.default.string(),
67
+ order: zod_1.default.number(),
68
+ isPublic: zod_1.default.boolean(),
69
+ isDefault: zod_1.default.boolean(),
70
+ createdBy: zod_1.default.string(),
71
+ createdOn: zod_1.default.string(),
72
+ lastModifiedOn: zod_1.default.string(),
73
+ })
74
+ .and(exports.sViewConfig);
package/dist/webrtc-playback.d.ts ADDED
@@ -0,0 +1,20 @@
1
+ import z from 'zod';
2
+ export declare const sCreatePlaybackControllerRequest: z.ZodObject<{
3
+ sources: z.ZodArray<z.ZodString, "many">;
4
+ initTime: z.ZodNumber;
5
+ }, "strip", z.ZodTypeAny, {
6
+ sources: string[];
7
+ initTime: number;
8
+ }, {
9
+ sources: string[];
10
+ initTime: number;
11
+ }>;
12
+ export type CreatePlaybackControllerRequest = z.infer<typeof sCreatePlaybackControllerRequest>;
13
+ export declare const sCreatePlaybackControllerResponse: z.ZodObject<{
14
+ id: z.ZodString;
15
+ }, "strip", z.ZodTypeAny, {
16
+ id: string;
17
+ }, {
18
+ id: string;
19
+ }>;
20
+ export type CreatePlaybackControllerResponse = z.infer<typeof sCreatePlaybackControllerResponse>;
package/dist/webrtc-playback.js ADDED
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.sCreatePlaybackControllerResponse = exports.sCreatePlaybackControllerRequest = void 0;
7
+ const zod_1 = __importDefault(require("zod"));
8
+ exports.sCreatePlaybackControllerRequest = zod_1.default.object({
9
+ sources: zod_1.default.array(zod_1.default.string().nonempty()),
10
+ initTime: zod_1.default.number().nonnegative(),
11
+ });
12
+ exports.sCreatePlaybackControllerResponse = zod_1.default.object({
13
+ id: zod_1.default.string().nonempty(),
14
+ });
package/package.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "name": "@awarevue/api-types",
3
+ "version": "1.0.1",
4
+ "description": "Common types between backend, agent(s) and frontend(s)",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "import": "./dist/index.js",
10
+ "require": "./dist/index.js",
11
+ "types": "./dist/index.d.ts"
12
+ }
13
+ },
14
+ "license": "MIT",
15
+ "peerDependencies": {
16
+ "zod": "^3.24.2"
17
+ },
18
+ "devDependencies": {
19
+ "@types/json-schema": "^7.0.15",
20
+ "@typescript-eslint/eslint-plugin": "^8.31.1",
21
+ "@typescript-eslint/parser": "^8.31.1",
22
+ "eslint": "^9.26.0",
23
+ "eslint-config-prettier": "^10.1.2",
24
+ "eslint-plugin-import": "^2.31.0",
25
+ "typescript": "~5.8.3",
26
+ "zod": "^3.24.2"
27
+ },
28
+ "scripts": {
29
+ "build": "tsc && cp package.json dist/",
30
+ "prepare": "yarn run build",
31
+ "lint": "eslint packages --ext .ts,.tsx"
32
+ },
33
+ "files": [
34
+ "dist"
35
+ ],
36
+ "publishConfig": {
37
+ "access": "public",
38
+ "registry": "https://registry.npmjs.org/"
39
+ }
40
+ }