@ixon-cdk/types 1.2.0-next.3 → 1.2.0-next.4

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 (51) hide show
  1. package/dist/types/component-context/index.d.ts +12 -0
  2. package/dist/types/logging-data/logging-data-query-ref.d.ts +2 -4
  3. package/dist/types/resource-data/resource-data.d.ts +107 -32
  4. package/package.json +1 -1
  5. package/dist/types/ixapi/resources/agent-config.d.ts +0 -115
  6. package/dist/types/ixapi/resources/agent-data-condition.d.ts +0 -11
  7. package/dist/types/ixapi/resources/agent-data-source.d.ts +0 -14
  8. package/dist/types/ixapi/resources/agent-data-tag.d.ts +0 -22
  9. package/dist/types/ixapi/resources/agent-data-variable.d.ts +0 -24
  10. package/dist/types/ixapi/resources/agent-device.d.ts +0 -11
  11. package/dist/types/ixapi/resources/agent-mdr-server.d.ts +0 -4
  12. package/dist/types/ixapi/resources/agent-membership.d.ts +0 -6
  13. package/dist/types/ixapi/resources/agent-network-value.d.ts +0 -5
  14. package/dist/types/ixapi/resources/agent-router-vpn-access-rule.d.ts +0 -8
  15. package/dist/types/ixapi/resources/agent-server.d.ts +0 -22
  16. package/dist/types/ixapi/resources/agent-template.d.ts +0 -3
  17. package/dist/types/ixapi/resources/agent-type.d.ts +0 -24
  18. package/dist/types/ixapi/resources/agent.d.ts +0 -148
  19. package/dist/types/ixapi/resources/alarming-app.d.ts +0 -5
  20. package/dist/types/ixapi/resources/asset-membership.d.ts +0 -6
  21. package/dist/types/ixapi/resources/asset-type.d.ts +0 -5
  22. package/dist/types/ixapi/resources/asset.d.ts +0 -19
  23. package/dist/types/ixapi/resources/audience.d.ts +0 -6
  24. package/dist/types/ixapi/resources/branding.d.ts +0 -27
  25. package/dist/types/ixapi/resources/company.d.ts +0 -55
  26. package/dist/types/ixapi/resources/custom-property.d.ts +0 -47
  27. package/dist/types/ixapi/resources/data-protocol-applied.d.ts +0 -72
  28. package/dist/types/ixapi/resources/demo-device.d.ts +0 -8
  29. package/dist/types/ixapi/resources/email-address-change.d.ts +0 -9
  30. package/dist/types/ixapi/resources/group-type.d.ts +0 -6
  31. package/dist/types/ixapi/resources/group.d.ts +0 -10
  32. package/dist/types/ixapi/resources/invite.d.ts +0 -25
  33. package/dist/types/ixapi/resources/licence-type.d.ts +0 -13
  34. package/dist/types/ixapi/resources/licence.d.ts +0 -25
  35. package/dist/types/ixapi/resources/location.d.ts +0 -11
  36. package/dist/types/ixapi/resources/logging-app.d.ts +0 -5
  37. package/dist/types/ixapi/resources/lsi-server.d.ts +0 -4
  38. package/dist/types/ixapi/resources/otp-auth.d.ts +0 -13
  39. package/dist/types/ixapi/resources/page-component.d.ts +0 -44
  40. package/dist/types/ixapi/resources/page-link-group.d.ts +0 -7
  41. package/dist/types/ixapi/resources/page-link.d.ts +0 -12
  42. package/dist/types/ixapi/resources/page-page.d.ts +0 -6
  43. package/dist/types/ixapi/resources/page-version.d.ts +0 -22
  44. package/dist/types/ixapi/resources/platform-server.d.ts +0 -8
  45. package/dist/types/ixapi/resources/policy.d.ts +0 -23
  46. package/dist/types/ixapi/resources/res-link.d.ts +0 -6
  47. package/dist/types/ixapi/resources/rsc-server.d.ts +0 -6
  48. package/dist/types/ixapi/resources/sector.d.ts +0 -31
  49. package/dist/types/ixapi/resources/user-membership.d.ts +0 -11
  50. package/dist/types/ixapi/resources/user.d.ts +0 -55
  51. package/dist/types/ixapi/resources/vpn-protocol.d.ts +0 -1
@@ -18,6 +18,18 @@ export interface ComponentContext<ComponentContextInputs extends object = {
18
18
  * Application data.
19
19
  */
20
20
  appData: ComponentContextAppData;
21
+ /**
22
+ * The component's base URL. This can be used to compose an absolute URL to a static component asset.
23
+ *
24
+ * For example:
25
+ *
26
+ * ```
27
+ * new URL('./static/image.png', context.componentBaseUrl).href;
28
+ * ```
29
+ *
30
+ * @experimental
31
+ */
32
+ componentBaseUrl: string;
21
33
  /**
22
34
  * True if `destroy` is called and has destroyed all clients.
23
35
  */
@@ -1,10 +1,8 @@
1
1
  /** @module LoggingDataQueryRef */
2
- import type { AgentDataTag } from '../ixapi/resources/agent-data-tag';
3
- import type { AgentDataVariable } from '../ixapi/resources/agent-data-variable';
4
2
  import type { LoggingDataQuery } from './logging-data-query';
5
3
  export interface LoggingDataQueryRef {
6
4
  query: LoggingDataQuery;
7
- variable?: AgentDataVariable;
8
- tag?: AgentDataTag;
5
+ variable?: any;
6
+ tag?: any;
9
7
  cancel(): void;
10
8
  }
@@ -1,18 +1,4 @@
1
- import type { Agent, AgentUserAgent } from '../ixapi/resources/agent';
2
- import type { AgentDataSource } from '../ixapi/resources/agent-data-source';
3
- import type { AgentServer } from '../ixapi/resources/agent-server';
4
- import type { AgentType } from '../ixapi/resources/agent-type';
5
- import type { Asset } from '../ixapi/resources/asset';
6
- import type { AssetType } from '../ixapi/resources/asset-type';
7
- import type { Branding, BrandingTheme } from '../ixapi/resources/branding';
8
- import type { CustomProperty } from '../ixapi/resources/custom-property';
9
- import type { Location } from '../ixapi/resources/location';
10
- import type { Group } from '../ixapi/resources/group';
11
- import type { GroupType } from '../ixapi/resources/group-type';
12
- import type { PagePage } from '../ixapi/resources/page-page';
13
- import type { PageVersion } from '../ixapi/resources/page-version';
14
- import type { MyUser, User } from '../ixapi/resources/user';
15
- interface AgentResourceData extends Pick<Agent, 'custom' | 'description' | 'loggingMdrServer' | 'loggingMqttChangedOn' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'name' | 'publicId' | 'rateLimiting' | 'serialNumber'> {
1
+ interface AgentResourceData {
16
2
  activeVpnSession?: {
17
3
  rscServer?: {
18
4
  name?: string;
@@ -20,39 +6,128 @@ interface AgentResourceData extends Pick<Agent, 'custom' | 'description' | 'logg
20
6
  } | null;
21
7
  vpnAddress?: string;
22
8
  } | null;
23
- connectedUsers?: Pick<User, 'name' | 'publicId'>[];
24
- dataSources?: Pick<AgentDataSource, 'name' | 'publicId' | 'slug'>[];
25
- lastSeenAgentUserAgent?: Pick<AgentUserAgent, 'firmwareVersion' | 'hardware' | 'hardwareVersion' | 'publicId'> | null;
26
- location?: Pick<Location, 'name'> | null;
9
+ connectedUsers?: {
10
+ name?: string;
11
+ publicId: string;
12
+ }[];
13
+ custom?: Record<string, any>;
14
+ dataSources?: {
15
+ name?: string | null;
16
+ publicId: string;
17
+ slug?: string | null;
18
+ }[];
19
+ description?: string | null;
20
+ lastSeenAgentUserAgent?: {
21
+ firmwareVersion?: string | null;
22
+ hardware?: string | null;
23
+ hardwareVersion?: string | null;
24
+ publicId: string;
25
+ } | null;
26
+ location?: {
27
+ name?: string | null;
28
+ } | null;
29
+ loggingMdrServer?: {
30
+ name?: string;
31
+ publicId: string;
32
+ } | null;
33
+ loggingMqttChangedOn?: string | null;
34
+ macAddress?: string | null;
35
+ mdrServer?: {
36
+ name?: string;
37
+ publicId: string;
38
+ } | null;
27
39
  memberships?: {
28
40
  group?: {
29
41
  publicId: string;
30
42
  };
31
43
  publicId: string;
32
44
  }[];
33
- servers?: Pick<AgentServer, 'custom' | 'name' | 'publicId' | 'serviceGroup' | 'type'>[];
34
- type?: Pick<AgentType, 'name' | 'publicId'>;
45
+ mqttChangedOn?: string | null;
46
+ name?: string;
47
+ publicId: string;
48
+ rateLimiting?: {
49
+ configMqttCommandCounter?: number;
50
+ configMqttCommandLastHit?: string;
51
+ configMqttCommandLimit?: 'soft' | 'hard' | 'lock' | null;
52
+ configMqttDataCounter?: number;
53
+ configMqttDataLastHit?: string;
54
+ configMqttDataLimit?: 'soft' | 'hard' | 'lock' | null;
55
+ configOpenvpnCounter?: number;
56
+ configOpenvpnLastHit?: string;
57
+ configOpenvpnLimit?: 'soft' | 'hard' | 'lock' | null;
58
+ };
59
+ serialNumber?: string | null;
60
+ servers?: {
61
+ custom?: Record<string, any>;
62
+ name?: string;
63
+ publicId: string;
64
+ serviceGroup?: string | null;
65
+ type?: 'http' | 'rdp' | 'vnc' | 'websocket';
66
+ visibleInMobileApp?: boolean;
67
+ }[];
68
+ type?: {
69
+ name?: string;
70
+ publicId: string;
71
+ };
72
+ vpnVisibleInMobileApp?: boolean;
35
73
  }
36
- interface AssetResourceData extends Pick<Asset, 'custom' | 'description' | 'name' | 'publicId'> {
74
+ interface AssetResourceData {
75
+ custom?: Record<string, any>;
76
+ description?: string | null;
37
77
  memberships?: {
38
78
  group?: {
39
79
  publicId: string;
40
80
  };
41
81
  publicId: string;
42
82
  }[];
43
- resourceVariant?: Pick<AssetType, 'publicId'>;
83
+ name?: string;
84
+ publicId: string;
85
+ resourceVariant?: {
86
+ publicId: string;
87
+ };
44
88
  }
45
- interface BrandingResourceData extends Pick<Branding, 'logo' | 'publicId'> {
46
- theme?: Pick<BrandingTheme, 'logoHasBackgroundColor'> | null;
89
+ interface BrandingResourceData {
90
+ logo?: string | null;
91
+ publicId: string;
92
+ theme?: {
93
+ logoHasBackgroundColor?: boolean;
94
+ } | null;
47
95
  }
48
- type CustomPropertyResourceData = Pick<CustomProperty, 'flags' | 'name' | 'publicId' | 'resourceType' | 'resourceVariant' | 'scopeType' | 'slug'>;
49
- interface GroupResourceData extends Pick<Group, 'name' | 'publicId'> {
50
- type?: Pick<GroupType, 'name' | 'order' | 'publicId'> | null;
96
+ interface CustomPropertyResourceData {
97
+ flags?: string[];
98
+ name?: string;
99
+ publicId: string;
100
+ resourceType?: string;
101
+ resourceVariant?: string | null;
102
+ scopeType?: 'glb' | 'app' | 'sct' | 'usr' | 'com';
103
+ slug?: string;
51
104
  }
52
- type MyUserResourceData = Pick<MyUser, 'custom' | 'name' | 'publicId' | 'unreadMessagesCount'>;
53
- type PagePageResourceData = Pick<PagePage, 'order' | 'publicId'>;
54
- interface PageVersionResourceData extends Pick<PageVersion, 'publicId' | 'title'> {
55
- pagePages?: Pick<PagePage, 'order' | 'publicId'>[];
105
+ interface GroupResourceData {
106
+ name?: string | null;
107
+ publicId: string;
108
+ type?: {
109
+ name?: string;
110
+ order?: number;
111
+ publicId: string;
112
+ } | null;
113
+ }
114
+ interface MyUserResourceData {
115
+ custom?: Record<string, any>;
116
+ name?: string;
117
+ publicId: string;
118
+ unreadMessagesCount?: number;
119
+ }
120
+ interface PagePageResourceData {
121
+ order?: number | null;
122
+ publicId: string;
123
+ }
124
+ interface PageVersionResourceData {
125
+ pagePages?: {
126
+ order?: number | null;
127
+ publicId: string;
128
+ }[];
129
+ publicId: string;
130
+ title?: string | null;
56
131
  }
57
132
  export declare namespace ResourceData {
58
133
  type Agent = AgentResourceData;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ixon-cdk/types",
3
- "version": "1.2.0-next.3",
3
+ "version": "1.2.0-next.4",
4
4
  "description": "",
5
5
  "main": "./dist/component-devkit/src/types/src/index.d.ts",
6
6
  "author": "",
@@ -1,115 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentConfig {
3
- agent?: ResLink;
4
- configFileReported?: string | null;
5
- configFileReportedWlanKeyEnabled?: boolean;
6
- configFileServer?: string | null;
7
- configPushedOn?: string | null;
8
- configReportedOn?: string | null;
9
- /** @deprecated */
10
- configsAreDifferent?: boolean;
11
- differentConfigs?: boolean;
12
- differentStewardConfigs?: boolean;
13
- /** NOTE: This public ID is identical to the public ID of its linked agent. */
14
- publicId: string;
15
- routerAdditionalSubnets?: AgentRouterAdditionalSubnet[];
16
- routerDisplay?: AgentConfigRouterDisplay | null;
17
- routerLan?: AgentConfigRouterLan | null;
18
- routerPortForwards?: AgentRouterPortForward[];
19
- routerWan?: AgentConfigRouterWan | null;
20
- stewardConfigFileReported?: string;
21
- stewardConfigFileServer?: string;
22
- stewardConfigReportedOn?: string | null;
23
- /** @deprecated */
24
- stewardConfigsAreDifferent?: boolean;
25
- }
26
- export interface AgentRouterAdditionalSubnet {
27
- agent?: ResLink;
28
- gatewayAddress?: string;
29
- networkAddress?: string;
30
- networkMask?: string;
31
- publicId: string;
32
- }
33
- export interface AgentConfigRouterDisplay {
34
- agent?: ResLink;
35
- lockEnabled?: boolean;
36
- lockCode?: string | null;
37
- }
38
- export interface AgentConfigRouterLan {
39
- agent?: ResLink;
40
- bacnetBbmd?: string[] | null;
41
- dhcpServerEnabled?: boolean;
42
- dhcpServerRangeFrom?: string;
43
- dhcpServerRangeTo?: string;
44
- forwardLanWan?: AgentConfigRouterForwardLanWan;
45
- gatewayLessRouting?: boolean;
46
- ipAddress?: string;
47
- netMask?: string;
48
- network?: string;
49
- udpBroadcastRelayPort?: number[] | null;
50
- wlanChannel?: number | null /** range between 1-14 */;
51
- wlanEnable?: boolean | null;
52
- wlanSsid?: string | null;
53
- wlanKey?: string | null;
54
- }
55
- export type AgentConfigRouterForwardLanWan = 'both' | 'private' | 'public' | 'neither';
56
- export interface AgentRouterPortForward {
57
- agent?: ResLink;
58
- externalPort?: number;
59
- interface?: 'VPN' | 'WAN';
60
- publicId: string;
61
- targetIpAddress?: string;
62
- targetPort?: number;
63
- }
64
- export interface AgentConfigRouterWan {
65
- /** @deprecated */
66
- '3gApn'?: string | null;
67
- /** @deprecated */
68
- '3gPincode'?: string | null;
69
- /** @deprecated */
70
- '3gTrackInterval'?: number;
71
- /** @deprecated */
72
- '3gTrackIps'?: string[];
73
- agent?: ResLink;
74
- cellularApn?: string | null;
75
- cellularMtu?: number | null;
76
- cellularPincode?: string | null;
77
- cellularTrackInterval?: number;
78
- cellularTrackIps?: string[];
79
- digitalInputMode?: AgentConfigRouterWanDigitalInputMode;
80
- dnsServer?: string | null /** @depricated */;
81
- dnsServers?: string[] | null;
82
- httpProxyAddress?: string | null;
83
- httpProxyAuthentication?: 'none' | 'basic' | 'ntlm' | null;
84
- httpProxyIsSocks5?: boolean | null;
85
- httpProxyPassword?: string | null /** @hidden */;
86
- httpProxyPort?: number | null;
87
- httpProxyUsername?: string | null;
88
- ipAddress?: string | null;
89
- ipGateway?: string | null;
90
- ipNetMask?: string | null;
91
- ipUseDhcp?: boolean;
92
- multiwanPolicy?: AgentConfigRouterMultiwanPolicy;
93
- wanTrackInterval?: number;
94
- wanTrackIps?: string[];
95
- wlanDnsServers?: string[] | null;
96
- wlanIpAddress?: string | null;
97
- wlanIpGateway?: string | null;
98
- wlanIpNetMask?: string | null;
99
- wlanIpUseDhcp?: boolean | null;
100
- wlanKey?: string | null /** @hidden */;
101
- wlanSsid?: string | null;
102
- wlanTrackInterval?: number;
103
- wlanTrackIps?: string[];
104
- }
105
- export interface AgentConfigRouterWlan {
106
- wlanKey?: string | null /** @hidden */;
107
- wlanSsid?: string | null;
108
- wlanDnsServers?: string[] | null;
109
- wlanIpAddress?: string | null;
110
- wlanIpGateway?: string | null;
111
- wlanIpNetMask?: string | null;
112
- wlanIpUseDhcp?: boolean | null;
113
- }
114
- export type AgentConfigRouterMultiwanPolicy = 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth';
115
- export type AgentConfigRouterWanDigitalInputMode = 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low' | null;
@@ -1,11 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentDataCondition {
3
- agent?: ResLink;
4
- description?: string | null;
5
- device?: ResLink;
6
- /** For example: "#2 8 >=" (when variable 2 is greater than or equal to 8) */
7
- formula?: string;
8
- name?: string;
9
- publicId: string;
10
- source?: ResLink;
11
- }
@@ -1,14 +0,0 @@
1
- import type { DataProtocolAppliedUnion } from './data-protocol-applied';
2
- import type { ResLink } from './res-link';
3
- export interface AgentDataSource {
4
- agent?: ResLink;
5
- device?: ResLink;
6
- disabled?: boolean;
7
- name?: string | null;
8
- port?: number | null;
9
- protocol?: DataProtocolAppliedUnion;
10
- publicId: string;
11
- pullDelay?: number | null;
12
- slug?: string | null;
13
- valuesPerHour?: number;
14
- }
@@ -1,22 +0,0 @@
1
- import type { AgentDataCondition } from './agent-data-condition';
2
- import type { AgentDataVariable } from './agent-data-variable';
3
- import type { ResLink } from './res-link';
4
- export interface AgentDataTag {
5
- agent?: ResLink;
6
- aggregators?: string[];
7
- device?: ResLink;
8
- downsamplingInterval?: boolean;
9
- /** When set to null will revert to "last", "shortest" and "longest". Only applicable to strings */
10
- edgeAggregator?: 'min' | 'max' | 'shortest' | 'longest' | 'mean' | 'last' | 'increase' | null;
11
- logEvent?: 'interval' | 'change' | 'trigger';
12
- loggingInterval?: string;
13
- logTrigger?: AgentDataCondition | null;
14
- name?: string;
15
- publicId: string;
16
- retentionPolicy?: string;
17
- slug?: string | null;
18
- source?: ResLink;
19
- onChangeExpiry?: string | null;
20
- tagId?: number;
21
- variable?: AgentDataVariable;
22
- }
@@ -1,24 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentDataVariable {
3
- address?: string;
4
- agent?: ResLink;
5
- device?: ResLink;
6
- extraData?: any;
7
- factor?: number | null;
8
- forAlarming?: boolean;
9
- forLogging?: boolean;
10
- internalUse?: boolean;
11
- maxStringLength?: number | null;
12
- name?: string;
13
- publicId: string;
14
- signed?: boolean | null;
15
- slug?: string | null;
16
- source?: ResLink;
17
- type?: AgentDataVariableType;
18
- unit?: string | null;
19
- updateable?: boolean;
20
- variableId?: number;
21
- width?: AgentDataVariableWidth | null;
22
- }
23
- export type AgentDataVariableType = 'bool' | 'int' | 'float' | 'str';
24
- export type AgentDataVariableWidth = '8' | '16' | '32' | '64';
@@ -1,11 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- import type { AgentDataSource } from './agent-data-source';
3
- export interface AgentDevice {
4
- agent?: ResLink;
5
- customAddress?: string | null;
6
- dataSources?: AgentDataSource[];
7
- ipAddress?: string | null;
8
- macAddress?: string | null;
9
- name?: string | null;
10
- publicId: string;
11
- }
@@ -1,4 +0,0 @@
1
- export interface AgentMdrServer {
2
- name?: string;
3
- publicId: string;
4
- }
@@ -1,6 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentMembership {
3
- agent?: ResLink;
4
- group?: ResLink;
5
- publicId: string;
6
- }
@@ -1,5 +0,0 @@
1
- export interface AgentNetworkValue {
2
- interface?: string;
3
- name: string;
4
- value: string[];
5
- }
@@ -1,8 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentRouterVpnAccessRule {
3
- agent?: ResLink;
4
- audience?: ResLink;
5
- ipAddress?: string;
6
- netMask?: string;
7
- publicId: string;
8
- }
@@ -1,22 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AgentServer {
3
- agent?: ResLink;
4
- audience?: ResLink | null;
5
- connectionQuality?: 'high' | 'normal' | 'low' | null;
6
- custom?: {};
7
- device?: ResLink;
8
- landingPage?: string;
9
- name?: string;
10
- password?: string | null;
11
- port?: number;
12
- publicId: string;
13
- readOnly?: boolean | null;
14
- serviceGroup?: string | null;
15
- template?: {
16
- publicId?: string;
17
- };
18
- type?: 'http' | 'rdp' | 'vnc' | 'websocket';
19
- username?: string | null;
20
- useSsl?: boolean;
21
- vncEncoding?: string | null;
22
- }
@@ -1,3 +0,0 @@
1
- import type { AgentLike } from './agent';
2
- export interface AgentTemplate extends AgentLike {
3
- }
@@ -1,24 +0,0 @@
1
- import type { AgentServer } from './agent-server';
2
- export interface AgentType {
3
- additionalSubnets?: boolean;
4
- allowDataPublishing?: boolean;
5
- allowDemoDevice?: boolean;
6
- allowReboot?: boolean;
7
- allowTemplating?: boolean;
8
- configPush?: boolean;
9
- configFileFormat?: number;
10
- customServers?: boolean;
11
- deviceIdFormat?: string;
12
- httpProxyPort?: number;
13
- latestFirmwareFile?: any;
14
- name?: string;
15
- offlineConfiguration?: boolean;
16
- publicId: string;
17
- purchasePrice?: {
18
- gratis?: boolean;
19
- };
20
- router?: boolean;
21
- servers?: AgentServer[];
22
- stunnelSupport?: boolean;
23
- wanPortForwardings?: boolean;
24
- }
@@ -1,148 +0,0 @@
1
- import type { AgentConfig } from './agent-config';
2
- import type { AgentDataSource } from './agent-data-source';
3
- import type { AgentDevice } from './agent-device';
4
- import type { AgentMdrServer } from './agent-mdr-server';
5
- import type { AgentMembership } from './agent-membership';
6
- import type { AgentNetworkValue } from './agent-network-value';
7
- import type { AgentServer } from './agent-server';
8
- import type { AgentTemplate } from './agent-template';
9
- import type { AgentType } from './agent-type';
10
- import type { AlarmingApp } from './alarming-app';
11
- import type { Audience } from './audience';
12
- import type { DemoDevice } from './demo-device';
13
- import type { Invite } from './invite';
14
- import type { Licence } from './licence';
15
- import type { LsiServer } from './lsi-server';
16
- import type { GeoLocation, Location } from './location';
17
- import type { LoggingApp } from './logging-app';
18
- import type { PageLink } from './page-link';
19
- import type { ResLink } from './res-link';
20
- import type { RscServer } from './rsc-server';
21
- import type { User } from './user';
22
- import type { VpnProtocol } from './vpn-protocol';
23
- import type { AgentRouterVpnAccessRule } from './agent-router-vpn-access-rule';
24
- export interface Agent extends AgentLike {
25
- activationLicence?: Licence | null;
26
- activeStatus?: 'active' | 'inactive';
27
- activeVpnSession?: AgentVpnSession | null;
28
- alarmingApp?: AlarmingApp;
29
- company?: ResLink;
30
- connectedUsers?: User[];
31
- demoDevice?: DemoDevice | null;
32
- deviceId?: string | null;
33
- fixedVpnAddress?: string | null;
34
- geoLocation?: GeoLocation | null;
35
- invitesWithAccess?: Invite[];
36
- lastSeenAgentUserAgent?: AgentUserAgent | null;
37
- location?: Location | null;
38
- loggingApp?: LoggingApp;
39
- loggingMdrServer?: AgentMdrServer | null;
40
- loggingMqttChangedOn?: string | null;
41
- lsiServer?: LsiServer | null;
42
- macAddress?: string | null;
43
- mdrServer?: AgentMdrServer | null;
44
- memberships?: AgentMembership[];
45
- mqttChangedOn?: string | null;
46
- networkReportedOn?: string | null;
47
- networkValues?: AgentNetworkValue[] | null;
48
- pendingRegistration?: boolean | null;
49
- /** default: false */
50
- preferLocationOverGeoip?: boolean;
51
- pullCodeGeneratedOn?: string | null;
52
- rateLimiting?: AgentRateLimiting;
53
- replaceMacAddress?: string | null;
54
- replaceRegistration?: boolean;
55
- reRegistration?: boolean;
56
- serialNumber?: string | null;
57
- timeZone?: string | null;
58
- valuesPerHour?: number;
59
- vpnAccessRules?: AgentRouterVpnAccessRule[];
60
- }
61
- export interface AgentLike {
62
- card?: ResLink | null;
63
- config?: AgentConfig | null;
64
- custom?: {
65
- [key: string]: any;
66
- };
67
- dataAudience?: Audience | null;
68
- dataSources?: AgentDataSource[];
69
- description?: string | null;
70
- devices?: AgentDevice[];
71
- name?: string;
72
- pageLinks?: PageLink[];
73
- publicId: string;
74
- servers?: AgentServer[];
75
- type?: AgentType;
76
- /** default: false */
77
- useStunnel?: boolean;
78
- preferLocationOverGeoip?: boolean;
79
- vpnAudience?: Audience | null;
80
- /** default: 'tcp' */
81
- vpnProtocol?: VpnProtocol;
82
- }
83
- export interface AgentLocalIp {
84
- reportedOn?: string;
85
- dnsServers?: string[];
86
- addresses?: string[];
87
- gateways?: string[];
88
- }
89
- export interface AgentUserAgent {
90
- appName?: string;
91
- appVersion?: string | null;
92
- configName?: string | null;
93
- configVersion?: string | null;
94
- firmwareVersion?: string | null;
95
- hardware?: string | null;
96
- hardwareCode?: string | null;
97
- hardwareVersion?: string | null;
98
- libixagentVersion?: string;
99
- libixloggerVersion?: string;
100
- opensslVersion?: string | null;
101
- osName?: string | null;
102
- osVersion?: string | null;
103
- publicId: string;
104
- }
105
- export interface AgentRateLimiting {
106
- configMqttCommandCounter?: number;
107
- configMqttCommandLastHit?: string;
108
- configMqttCommandLimit?: AgentRateLimitingStatus;
109
- configMqttDataCounter?: number;
110
- configMqttDataLastHit?: string;
111
- configMqttDataLimit?: AgentRateLimitingStatus;
112
- configOpenvpnCounter?: number;
113
- configOpenvpnLastHit?: string;
114
- configOpenvpnLimit?: AgentRateLimitingStatus;
115
- }
116
- /**
117
- * - `null` when ratelimiting is not applicable.
118
- * - `"soft"` when it is periodically retrying.
119
- * - `"hard"` when a user must manually force a retry.
120
- * - `"lock"` when it manually locked by R&D and the user unable to retry.
121
- */
122
- export type AgentRateLimitingStatus = null | 'soft' | 'hard' | 'lock';
123
- export interface AgentVpnSession {
124
- bytesReceived?: number;
125
- bytesSent?: number;
126
- duration?: number;
127
- startedOn?: number;
128
- rscServer?: RscServer | null;
129
- vpnAddress?: string;
130
- }
131
- export interface AgentFromTemplate {
132
- publicId: string;
133
- template: AgentTemplate;
134
- importLanSettings: boolean;
135
- importFirewallSettings: boolean;
136
- importPageLinks: boolean;
137
- importServices: boolean;
138
- importDataSettings: boolean;
139
- importCustomProperties: boolean;
140
- }
141
- export interface ShellAgentCreate {
142
- registrationCode: string;
143
- name?: string | null;
144
- couponCode?: string | null;
145
- licence?: ResLink | null;
146
- groups?: ResLink[];
147
- template?: ResLink | null;
148
- }
@@ -1,5 +0,0 @@
1
- import type { Licence } from './licence';
2
- export interface AlarmingApp {
3
- enabled?: boolean;
4
- licence?: Licence | null;
5
- }
@@ -1,6 +0,0 @@
1
- import type { ResLink } from './res-link';
2
- export interface AssetMembership {
3
- asset?: ResLink;
4
- group?: ResLink;
5
- publicId: string;
6
- }
@@ -1,5 +0,0 @@
1
- export interface AssetType {
2
- name?: string;
3
- order?: number;
4
- publicId: string;
5
- }