@ixon-cdk/types 1.17.0 → 1.18.0-next.2
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.
- package/dist/types/component-context/index.d.ts +20 -0
- package/dist/types/ixapi/resources/agent-access-request.d.ts +8 -0
- package/dist/types/ixapi/resources/agent-edge-app-instance.d.ts +1 -2
- package/dist/types/ixapi/resources/audit-log.d.ts +6 -6
- package/dist/types/ixapi/resources/controlled-device.d.ts +1 -1
- package/dist/types/logging-data/logging-data-query.d.ts +3 -3
- package/dist/types/resource-data/resource-data-query.d.ts +6 -6
- package/dist/types/resource-data/resource-data-update.d.ts +14 -0
- package/dist/types/resource-data/resource-data.d.ts +2 -0
- package/package.json +1 -1
|
@@ -126,6 +126,26 @@ export interface ComponentContext<ComponentContextInputs extends object = {
|
|
|
126
126
|
getApiUrl(rel: string, params?: {
|
|
127
127
|
[param: string]: string;
|
|
128
128
|
}): string;
|
|
129
|
+
/**
|
|
130
|
+
* Retrieves the *evaluated value* of a design token by name, typically a color (e.g., `"#ff0000"`), while also
|
|
131
|
+
* exposing a `.var()` method for retrieving the associated CSS custom property string (e.g., `"var(--uic-primary)"`).
|
|
132
|
+
*
|
|
133
|
+
* @param name The design token name, e.g., `'primary'`, `'error'`, `'background'`
|
|
134
|
+
* @returns The resolved token value as a string (e.g., color hex, spacing value, etc.)
|
|
135
|
+
*
|
|
136
|
+
* @example
|
|
137
|
+
* // Get the resolved value of a design token in JavaScript
|
|
138
|
+
* const color = context.getDesignToken('primary'); // → "#ff0000"
|
|
139
|
+
*
|
|
140
|
+
* // Get the CSS variable string for usage in markup or inline styles
|
|
141
|
+
* const cssVar = context.getDesignToken.var('primary'); // → "var(--uic-primary)"
|
|
142
|
+
*
|
|
143
|
+
* @experimental
|
|
144
|
+
*/
|
|
145
|
+
getDesignToken: {
|
|
146
|
+
(name: string): string;
|
|
147
|
+
var(name: string): string;
|
|
148
|
+
};
|
|
129
149
|
/**
|
|
130
150
|
* Use this method to navigate to a specific page in the portal, for example the VNC-viewer.
|
|
131
151
|
* Don't use this method to navigate to navigate outside the Portal.
|
|
@@ -5,6 +5,7 @@ export interface AgentAccessRequest {
|
|
|
5
5
|
agent?: ResLink;
|
|
6
6
|
allowedApprovers?: UserReference[];
|
|
7
7
|
approver?: UserReference | null;
|
|
8
|
+
approverCompany?: ResLink | null;
|
|
8
9
|
/** I.e. "2019-01-01T12:00:00Z" */
|
|
9
10
|
createdOn?: string;
|
|
10
11
|
/** I.e. "2019-01-01T12:00:00Z" */
|
|
@@ -31,4 +32,11 @@ interface AgentAccessRequestResult {
|
|
|
31
32
|
serviceNames: string[];
|
|
32
33
|
vpn: boolean;
|
|
33
34
|
}
|
|
35
|
+
export interface AgentAccessRequestApprover {
|
|
36
|
+
company?: ResLink;
|
|
37
|
+
/** @deprecated */
|
|
38
|
+
name?: string;
|
|
39
|
+
publicId: string;
|
|
40
|
+
user?: UserReference;
|
|
41
|
+
}
|
|
34
42
|
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { ResLink } from './res-link';
|
|
2
|
-
type EdgeAppInstanceDeploymentStatus = 'error' | 'deploying' | 'pending' | 'running';
|
|
2
|
+
export type EdgeAppInstanceDeploymentStatus = 'error' | 'deploying' | 'pending' | 'running';
|
|
3
3
|
export interface AgentEdgeAppInstance {
|
|
4
4
|
agent?: ResLink;
|
|
5
5
|
edgeAppVersion?: ResLink;
|
|
@@ -7,4 +7,3 @@ export interface AgentEdgeAppInstance {
|
|
|
7
7
|
publicId: string;
|
|
8
8
|
status?: EdgeAppInstanceDeploymentStatus;
|
|
9
9
|
}
|
|
10
|
-
export {};
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { GeoLocation } from './location';
|
|
2
|
-
export interface AuditLog {
|
|
2
|
+
export interface AuditLog<TData = any> {
|
|
3
3
|
action: AuditLogAction;
|
|
4
4
|
actor: AuditLogActor;
|
|
5
|
-
after:
|
|
6
|
-
application
|
|
5
|
+
after: TData[] | null;
|
|
6
|
+
application?: {
|
|
7
7
|
name: string;
|
|
8
8
|
} | null;
|
|
9
|
-
before:
|
|
9
|
+
before: TData[] | null;
|
|
10
10
|
publicId: string;
|
|
11
11
|
request?: AuditLogRequest;
|
|
12
12
|
target: string;
|
|
@@ -16,8 +16,8 @@ export interface AuditLog {
|
|
|
16
16
|
}
|
|
17
17
|
export type AuditLogAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER';
|
|
18
18
|
interface AuditLogRequest {
|
|
19
|
-
fromName
|
|
20
|
-
geoLocation
|
|
19
|
+
fromName?: string | null;
|
|
20
|
+
geoLocation?: GeoLocation | null;
|
|
21
21
|
ipAddress: string;
|
|
22
22
|
}
|
|
23
23
|
interface AuditLogActor {
|
|
@@ -8,7 +8,7 @@ export interface ControlledDevice {
|
|
|
8
8
|
publicId: string;
|
|
9
9
|
}
|
|
10
10
|
/** @check controlleddevice*/
|
|
11
|
-
export type ControlledDeviceAgentReference = Pick<Agent, 'activeVpnSession' | 'company' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
|
|
11
|
+
export type ControlledDeviceAgentReference = Pick<Agent, 'activeVpnSession' | 'company' | 'config' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
|
|
12
12
|
export interface ControlledDeviceCreate {
|
|
13
13
|
controlKey: string;
|
|
14
14
|
device: string;
|
|
@@ -47,7 +47,7 @@ export interface LoggingDataQuery {
|
|
|
47
47
|
*
|
|
48
48
|
* Must be null if offset is set
|
|
49
49
|
*/
|
|
50
|
-
postAggr?:
|
|
50
|
+
postAggr?: Aggregator;
|
|
51
51
|
/**
|
|
52
52
|
* Apply a transform. Only applies when postAggr is `'last'`.
|
|
53
53
|
*
|
|
@@ -58,7 +58,7 @@ export interface LoggingDataQuery {
|
|
|
58
58
|
* When omitted, the pre-aggregator is determined automatically based on a couple of factors, but
|
|
59
59
|
* in most cases it defaults to "raw".
|
|
60
60
|
*/
|
|
61
|
-
preAggr?:
|
|
61
|
+
preAggr?: Aggregator;
|
|
62
62
|
/**
|
|
63
63
|
* Reference used to identify the value. If not set, a unique reference is generated.
|
|
64
64
|
*
|
|
@@ -105,6 +105,6 @@ export interface LoggingDataQuery {
|
|
|
105
105
|
publicId: string;
|
|
106
106
|
} | null;
|
|
107
107
|
}
|
|
108
|
-
type
|
|
108
|
+
type Aggregator = 'count' | 'distinct' | 'integral' | 'mean' | 'median' | 'mode' | 'spread' | 'stddev' | 'sum' | 'first' | 'last' | 'max' | 'min' | 'raw';
|
|
109
109
|
type Transform = 'difference';
|
|
110
110
|
export {};
|
|
@@ -5,16 +5,16 @@ export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
|
|
|
5
5
|
* String reference unique to the query call made by the client
|
|
6
6
|
* @ignore
|
|
7
7
|
*/
|
|
8
|
-
_clientRef?: string
|
|
8
|
+
_clientRef?: string;
|
|
9
9
|
/**
|
|
10
10
|
* List of fields to get from the resource, see the
|
|
11
|
-
* [developer documentation](https://developer.ixon.cloud/docs/using-the-
|
|
11
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
|
|
12
12
|
* supported fields.
|
|
13
13
|
*/
|
|
14
14
|
fields: string[];
|
|
15
15
|
/**
|
|
16
16
|
* The name of the resource, see the
|
|
17
|
-
* [developer documentation](https://developer.ixon.cloud/docs/using-the-
|
|
17
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
|
|
18
18
|
* supported resources
|
|
19
19
|
*/
|
|
20
20
|
selector: T;
|
|
@@ -24,11 +24,11 @@ export interface ResourceDataTemplateQuery {
|
|
|
24
24
|
* String reference unique to the query call made by the client
|
|
25
25
|
* @ignore
|
|
26
26
|
*/
|
|
27
|
-
_clientRef?: string
|
|
27
|
+
_clientRef?: string;
|
|
28
28
|
/**
|
|
29
29
|
* Template to be interpolated. The format should be [Mustache](https://mustache.github.io), see the
|
|
30
|
-
* [developer documentation](https://developer.ixon.cloud/docs/using-the-
|
|
31
|
-
* supported fields. Only 'agent'
|
|
30
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
|
|
31
|
+
* supported fields. Only 'agent' and 'asset' are supported at the moment.
|
|
32
32
|
*
|
|
33
33
|
* If omitted, an empty object is returned
|
|
34
34
|
*/
|
|
@@ -6,8 +6,22 @@ type ResourceDataUpdateDataMap = {
|
|
|
6
6
|
};
|
|
7
7
|
export type ResourceDataUpdateSelector = keyof ResourceDataUpdateDataMap;
|
|
8
8
|
export type ResourceDataUpdate<T extends ResourceDataUpdateSelector = ResourceDataUpdateSelector> = {
|
|
9
|
+
/**
|
|
10
|
+
* String reference unique to the query call made by the client
|
|
11
|
+
* @ignore
|
|
12
|
+
*/
|
|
9
13
|
_clientRef?: string;
|
|
14
|
+
/**
|
|
15
|
+
* The name of the resource, see the
|
|
16
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
|
|
17
|
+
* supported resources
|
|
18
|
+
*/
|
|
10
19
|
selector: T;
|
|
20
|
+
/**
|
|
21
|
+
* The data to update the resource with, see the
|
|
22
|
+
* [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
|
|
23
|
+
* supported fields.
|
|
24
|
+
*/
|
|
11
25
|
data: ResourceDataUpdateDataMap[T];
|
|
12
26
|
};
|
|
13
27
|
export {};
|
|
@@ -94,9 +94,11 @@ interface AgentResourceData {
|
|
|
94
94
|
publicId: string;
|
|
95
95
|
};
|
|
96
96
|
vpnChangedOn?: string | null;
|
|
97
|
+
vpnLocked?: boolean;
|
|
97
98
|
vpnRequireAccessApproval?: boolean;
|
|
98
99
|
vpnVisibleInMobileApp?: boolean;
|
|
99
100
|
vpnVisibleOnWeb?: boolean;
|
|
101
|
+
webAccessLocked?: boolean;
|
|
100
102
|
}
|
|
101
103
|
interface AppConfigResourceData<TValues = unknown> {
|
|
102
104
|
publicId: string;
|