@ixon-cdk/types 1.21.0 → 1.22.0-next.0

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

@@ -12,8 +12,10 @@ export interface EdgeAppInstanceProgress {
 export type EdgeAppInstanceDeploymentStatus = 'deleting' | 'deploying' | 'error' | 'pending' | 'running';
 export type AgentEdgeAppInstance = {
     agent?: ResLink;
+    differentConfigs?: boolean;
     edgeAppVersion?: ResLink;
     files?: EdgeAppFile[];
+    lastEvent?: string | null;
     name?: string;
     publicId: string;
     services?: AgentEdgeAppInstanceService[];

package/dist/types/ixapi/resources/agent-server.d.ts

@@ -14,6 +14,7 @@ export interface AgentServer {
     port?: number;
     publicId: string;
     readOnly?: boolean | null;
+    recordSessions?: boolean | null;
     requireAccessApproval?: boolean;
     serviceGroup?: string | null;
     template?: AgentServerTemplate | null;
@@ -40,6 +41,7 @@ export interface AgentServerTemplate {
     port?: number;
     publicId: string;
     readOnly?: boolean | null;
+    recordSessions?: boolean | null;
     requireAccessApproval?: boolean;
     type?: AgentServerType;
     username?: string | null;
@@ -50,7 +52,7 @@ export interface AgentServerTemplate {
     vncRightClickOnTouchHold?: boolean;
 }
 export type AgentServerReference = Pick<AgentServer, 'name' | 'publicId'>;
-export type AgentServerType = 'http' | 'rdp' | 'rtsp' | 'vnc' | 'websocket';
+export type AgentServerType = 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket';
 export type ConnectionQuality = 'high' | 'normal' | 'low';
 type HttpAuthenticationType = 'ntlm' | 'basic' | 'digest';
 export {};

package/dist/types/ixapi/resources/asset.d.ts

@@ -26,7 +26,7 @@ export interface Asset {
     publicId: string;
     resourceVariant?: AssetType;
     root?: ResLink | null;
-    slug?: string;
+    slug?: string | null;
 }
 export interface AssetInstanceCreate {
     libraryAsset: ResLink;

package/dist/types/ixapi/resources/data-deletion-request.d.ts

@@ -0,0 +1,6 @@
+import type { ResLink } from './res-link';
+export interface DataDeletionRequestCreate {
+    end: string;
+    source: ResLink;
+    start: string;
+}

package/dist/types/ixapi/resources/data.d.ts

@@ -34,7 +34,7 @@ export interface DataQuery {
     postAggr?: string;
     postTransform?: 'difference' | null;
     ref: string;
-    step?: number | 'day' | 'week';
+    step?: number | 'day' | 'week' | 'month';
 }
 export interface DataRequest {
     end?: string;

package/dist/types/ixapi/resources/index.d.ts

@@ -58,14 +58,15 @@ export * from './company';
 export * from './controlled-device';
 export * from './controlled-device-membership';
 export * from './custom-property';
-export * from './data';
-export * from './data-protocol';
+export * from './data-deletion-request';
 export * from './data-protocol-applied';
+export * from './data-protocol';
+export * from './data';
 export * from './demo-device';
 export * from './discovery';
-export * from './edge-app';
 export * from './edge-app-file';
 export * from './edge-app-version';
+export * from './edge-app';
 export * from './email-address-change';
 export * from './file';
 export * from './file-upload';

package/dist/types/ixapi/resources/licence-type.d.ts

@@ -1,5 +1,5 @@
 export type LicenceTypeScope = 'agent' | 'company';
-export type LicenceUsageType = 'advanced-user-management' | 'agent-registration-profile' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
+export type LicenceUsageType = 'advanced-user-management' | 'agent-registration-profile' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'app-engine-level-3' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'controlled-devices' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'm2m-cloud-cluster' | 'main-pages' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'rdp' | 'remote-access' | 'reporting' | 'request-access' | 'rtsp' | 'scim' | 'session-recording' | 'sla' | 'ssh' | 'subgroups' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
 export interface LicenceType {
     companyLimit?: number | null;
     publicId: string;

package/dist/types/ixapi/resources/menu-item.d.ts

@@ -1,13 +1,31 @@
 import type { Audience } from './audience';
 import type { Page } from './page';
 import type { PageLink } from './page-link';
+import type { ResLink } from './res-link';
 export interface MenuItem {
     audience?: Audience | null;
-    custom?: {};
+    custom?: {
+        /** String reference for a material design named icon. */
+        glbMatIcon?: string;
+    };
     name?: string | null;
     order?: number;
-    page?: Page;
+    page?: Page | null;
     pageLinks?: PageLink[];
     pinned?: boolean;
     publicId: string;
 }
+export type MenuItemCreate = Pick<MenuItem, 'custom' | 'name' | 'order' | 'pinned'> & {
+    audience?: ResLink | null;
+    page?: ResLink | null;
+    pageLinks?: MenuItemPageLink[];
+};
+export type MenuItemUpdate = Pick<MenuItem, 'custom' | 'name' | 'order' | 'pinned' | 'publicId'> & {
+    audience?: ResLink | null;
+    page?: ResLink | null;
+    pageLinks?: MenuItemPageLink[];
+};
+export type MenuItemPageLink = Pick<PageLink, 'audience' | 'custom' | 'order' | 'page'> & {
+    audience?: ResLink | null;
+    group?: string | null;
+};

package/dist/types/ixapi/resources/web-access.d.ts

@@ -1,3 +1,13 @@
+import type { Agent } from './agent';
+import type { AgentServer } from './agent-server';
 export interface WebAccess {
-    url: string;
+    agent?: Agent;
+    agentServer?: AgentServer;
+    closeReason?: string | null;
+    expiresOn?: string;
+    publicId: string;
+}
+export interface WebAccessCreateResponse {
+    publicId: string;
+    url?: string;
 }

package/dist/types/logging-data/logging-data-client.d.ts

@@ -13,10 +13,16 @@ export interface LoggingDataClient {
      */
     destroy(): void;
     /**
-     * Starts a query for logging data. This method can be used for historic and live data depending
-     * on the selector.
+     * Starts a query for logging data. Results are delivered through the `listener` callback. This method can be used
+     * for historic and live data depending on the selector. The `listener` may be called multiple times in multiple
+     * cases, including but not limited to:
      *
-     * @returns {function()} Returns a deregistration function for the listener.
+     * * when new live data comes in
+     * * when a different time period is selected
+     * * when an auto-refresh is active
+     *
+     * @returns {function()} Returns a deregistration function for the listener. Until this function is called, or the
+     * client is destroyed, the `listener` callback will continue to get called.
      */
     query(query: LoggingDataQuery, listener: (result: LoggingDataMetric[]) => any): () => void;
     query(queries: LoggingDataQuery[], listener: (results: LoggingDataMetric[][]) => any): () => void;
@@ -26,6 +32,8 @@ export interface LoggingDataClient {
      *
      * - If `format` is `'csv'`, the result type is `LoggingDataBlob`
      * - Otherwise, the result type is `LoggingDataMetric[][]`
+     *
+     * If the `once` field is set to `true`, the query listener will be called at most once.
      */
     listener: (results: T extends {
         format: 'csv';

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

@@ -81,7 +81,7 @@ export interface LoggingDataQuery {
     /**
      * Number of seconds between subsequent data-points
      */
-    step?: number | 'day' | 'week';
+    step?: number | 'day' | 'week' | 'month';
     /**
      * The tag to fetch the data from. Must be null if variable is set
      */

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

@@ -34,7 +34,11 @@ export interface ResourceDataClient {
      */
     destroy(): void;
     /**
-     * @returns {function()} Returns a deregistration function for the listener.
+     * Starts a query for resource data. Results are delivered through the `listener` callback. The `listener` may be
+     * called multiple times when resource data changes.
+     *
+     * @returns {function()} Returns a deregistration function for the listener. Until this function is called, or the
+     * client is destroyed, the `listener` callback will continue to get called.
      */
     query<T extends ResourceDataQuerySelector>(query: ResourceDataQuery<T> | [ResourceDataQuery<T>], listener: (results: [ResourceDataResult<ResultDataMap[T]>]) => unknown): () => void;
     query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector>(query: [ResourceDataQuery<T1>, ResourceDataQuery<T2>], listener: (results: [ResourceDataResult<ResultDataMap[T1]>, ResourceDataResult<ResultDataMap[T2]>]) => unknown): () => void;

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

@@ -100,7 +100,7 @@ interface AgentResourceData {
         publicId: string;
         requireAccessApproval?: boolean;
         serviceGroup?: string | null;
-        type?: 'http' | 'rdp' | 'rtsp' | 'vnc' | 'websocket';
+        type?: 'http' | 'rdp' | 'rtsp' | 'ssh' | 'vnc' | 'websocket';
         visibleInMobileApp?: boolean;
         visibleOnWeb?: boolean;
     }[];

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.21.0",
+  "version": "1.22.0-next.0",
   "description": "",
+  "type": "module",
   "main": "./dist/component-devkit/src/types/src/index.d.ts",
+  "exports": {
+    ".": "./dist/component-devkit/src/types/src/index.d.ts"
+  },
   "author": "",
   "license": "ISC",
   "files": [