@ixon-cdk/types 1.18.0-next.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.
@@ -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: any[] | null;
6
- application: {
5
+ after: TData[] | null;
6
+ application?: {
7
7
  name: string;
8
8
  } | null;
9
- before: any[] | null;
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: string | null;
20
- geoLocation: GeoLocation | null;
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;
@@ -8,13 +8,13 @@ export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
8
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-resourcedataclient) for
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-resourcedataclient) for
17
+ * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
18
18
  * supported resources
19
19
  */
20
20
  selector: T;
@@ -27,8 +27,8 @@ export interface ResourceDataTemplateQuery {
27
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-resourcedataclient) for
31
- * supported fields. Only 'agent' is supported at the moment.
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 {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ixon-cdk/types",
3
- "version": "1.18.0-next.0",
3
+ "version": "1.18.0-next.2",
4
4
  "description": "",
5
5
  "main": "./dist/component-devkit/src/types/src/index.d.ts",
6
6
  "author": "",