@ixon-cdk/types 1.18.0-next.0 → 1.18.0

package/dist/types/ixapi/resources/agent-edge-app-instance.d.ts

@@ -1,5 +1,5 @@
 import type { ResLink } from './res-link';
-type EdgeAppInstanceDeploymentStatus = 'error' | 'deploying' | 'pending' | 'running';
+export type EdgeAppInstanceDeploymentStatus = 'error' | 'deploying' | 'pending' | 'running';
 export interface AgentEdgeAppInstance {
     agent?: ResLink;
     edgeAppVersion?: ResLink;
@@ -7,4 +7,3 @@ export interface AgentEdgeAppInstance {
     publicId: string;
     status?: EdgeAppInstanceDeploymentStatus;
 }
-export {};

package/dist/types/ixapi/resources/audit-log.d.ts

@@ -1,12 +1,12 @@
 import type { GeoLocation } from './location';
-export interface AuditLog {
+export interface AuditLog<TData = any> {
     action: AuditLogAction;
     actor: AuditLogActor;
-    after: any[] | null;
-    application: {
+    after: TData[] | null;
+    application?: {
         name: string;
     } | null;
-    before: any[] | null;
+    before: TData[] | null;
     publicId: string;
     request?: AuditLogRequest;
     target: string;
@@ -16,8 +16,8 @@ export interface AuditLog {
 }
 export type AuditLogAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER';
 interface AuditLogRequest {
-    fromName: string | null;
-    geoLocation: GeoLocation | null;
+    fromName?: string | null;
+    geoLocation?: GeoLocation | null;
     ipAddress: string;
 }
 interface AuditLogActor {

package/dist/types/ixapi/resources/controlled-device.d.ts

@@ -8,7 +8,7 @@ export interface ControlledDevice {
     publicId: string;
 }
 /** @check controlleddevice*/
-export type ControlledDeviceAgentReference = Pick<Agent, 'activeVpnSession' | 'company' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
+export type ControlledDeviceAgentReference = Pick<Agent, 'activeStatus' | 'activeVpnSession' | 'company' | 'config' | 'deviceId' | 'lastSeenAgentUserAgent' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'publicId' | 'serialNumber' | 'type' | 'vpnChangedOn' | 'vpnLocked' | 'webAccessLocked'>;
 export interface ControlledDeviceCreate {
     controlKey: string;
     device: string;

package/dist/types/resource-data/resource-data-add.d.ts

@@ -4,9 +4,23 @@ type ResourceDataAddDataMap = {
     AssetAppConfigResource: AtLeast<ResourceData.AssetAppConfigResource, 'resourceType' | 'resourcePublicId'>;
 };
 export type ResourceDataAddSelector = keyof ResourceDataAddDataMap;
-export type ResourceDataAdd<T extends ResourceDataAddSelector = ResourceDataAddSelector> = {
+export type ResourceDataAdd<TSelector extends ResourceDataAddSelector = ResourceDataAddSelector> = {
+    /**
+     * String reference unique to the add call made by the client.
+     * @ignore
+     */
     _clientRef?: string;
-    selector: T;
-    data: ResourceDataAddDataMap[T];
+    /**
+     * The name of the resource, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#adding-resources) for
+     * supported resources.
+     */
+    selector: TSelector;
+    /**
+     * The data to add the resource with, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#adding-resources) for
+     * supported fields.
+     */
+    data: ResourceDataAddDataMap[TSelector];
 };
 export {};

package/dist/types/resource-data/resource-data-query.d.ts

@@ -1,36 +1,36 @@
 /** @module ResourceDataQuery */
 export type ResourceDataQuerySelector = 'Agent' | 'AppConfig' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'LicenceList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
-export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
+export interface ResourceDataQuery<TSelector = ResourceDataQuerySelector> {
     /**
-     * String reference unique to the query call made by the client
+     * String reference unique to the query call made by the client.
      * @ignore
      */
     _clientRef?: string;
     /**
      * List of fields to get from the resource, see the
-     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resourcedataclient) for
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
      * supported fields.
      */
     fields: string[];
     /**
      * The name of the resource, see the
-     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resourcedataclient) for
-     * supported resources
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
+     * supported resources.
      */
-    selector: T;
+    selector: TSelector;
 }
 export interface ResourceDataTemplateQuery {
     /**
-     * String reference unique to the query call made by the client
+     * String reference unique to the query call made by the client.
      * @ignore
      */
     _clientRef?: string;
     /**
      * Template to be interpolated. The format should be [Mustache](https://mustache.github.io), see the
-     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resourcedataclient) for
-     * supported fields. Only 'agent' is supported at the moment.
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client) for
+     * supported fields. Only 'agent' and 'asset' are supported at the moment.
      *
-     * If omitted, an empty object is returned
+     * If omitted, an empty object is returned.
      */
     template: string;
 }

package/dist/types/resource-data/resource-data-remove.d.ts

@@ -3,9 +3,18 @@ type ResourceDataRemoveDataMap = {
     AssetAppConfigResource: Partial<ResourceData.AssetAppConfigResource>;
 };
 export type ResourceDataRemoveSelector = keyof ResourceDataRemoveDataMap;
-export type ResourceDataRemove<T extends ResourceDataRemoveSelector = ResourceDataRemoveSelector> = {
+export type ResourceDataRemove<TSelector extends ResourceDataRemoveSelector = ResourceDataRemoveSelector> = {
+    /**
+     * String reference unique to the remove call made by the client.
+     * @ignore
+     */
     _clientRef?: string;
     publicId: string;
-    selector: T;
+    /**
+     * The name of the resource, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#remove-resources) for
+     * supported resources.
+     */
+    selector: TSelector;
 };
 export {};

package/dist/types/resource-data/resource-data-result.d.ts

@@ -1,6 +1,6 @@
 /** @module ResourceDataResult */
 import type { ResourceDataQuery } from './resource-data-query';
-export interface ResourceDataResult<T = any> {
+export interface ResourceDataResult<TData = any> {
     query: ResourceDataQuery;
-    data: T | null;
+    data: TData | null;
 }

package/dist/types/resource-data/resource-data-update.d.ts

@@ -5,9 +5,23 @@ type ResourceDataUpdateDataMap = {
     AssetAppConfigResource: AtLeast<ResourceData.AssetAppConfigResource, 'publicId'>;
 };
 export type ResourceDataUpdateSelector = keyof ResourceDataUpdateDataMap;
-export type ResourceDataUpdate<T extends ResourceDataUpdateSelector = ResourceDataUpdateSelector> = {
+export type ResourceDataUpdate<TSelector extends ResourceDataUpdateSelector = ResourceDataUpdateSelector> = {
+    /**
+     * String reference unique to the update call made by the client.
+     * @ignore
+     */
     _clientRef?: string;
-    selector: T;
-    data: ResourceDataUpdateDataMap[T];
+    /**
+     * The name of the resource, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
+     * supported resources.
+     */
+    selector: TSelector;
+    /**
+     * The data to update the resource with, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resource-data-client#updating-resources) for
+     * supported fields.
+     */
+    data: ResourceDataUpdateDataMap[TSelector];
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.18.0-next.0",
+  "version": "1.18.0",
   "description": "",
   "main": "./dist/component-devkit/src/types/src/index.d.ts",
   "author": "",