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

package/dist/types/component-context/index.d.ts

@@ -8,7 +8,7 @@ import type { ComponentContextAppData } from './app-data';
 import type { ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
 import type { AlertDialogOptions, ConfirmDialogOptions, ContentDialogOptions, FormDialogOptions, FormDialogResult } from './dialog';
 import type { ActionMenuOptions, ActionMenuResult } from './menu';
-import { MultiSelectPanelOptions, MultiSelectPanelResult, SingleSelectPanelOptions, SingleSelectPanelResult } from './select';
+import type { MultiSelectPanelOptions, MultiSelectPanelResult, SingleSelectPanelOptions, SingleSelectPanelResult } from './select';
 import type { ToastOptions } from './toast';
 import type { Tooltip, TooltipOptions } from './tooltip';
 export type { ComponentContextAppData } from './app-data';

package/dist/types/ixapi/resources/agent-data-alarm-occurrence.d.ts

@@ -1,10 +1,11 @@
+import type { AgentDataAlarm } from './agent-data-alarm';
 import type { ResLink } from './res-link';
 export interface AgentDataAlarmOccurrence {
     acknowledged?: boolean;
     acknowledgedBy?: ResLink | null;
     /** I.e. "2019-01-01T12:00:00Z" */
     acknowledgedOn: string | null;
-    alarm?: ResLink;
+    alarm?: AgentDataAlarm;
     comment?: string | null;
     /** I.e. "2019-01-01T12:00:00Z" */
     occurredOn?: string;

package/dist/types/ixapi/resources/agent-data-tag.d.ts

@@ -11,7 +11,7 @@ export interface AgentDataTag {
     logEvent?: 'interval' | 'change' | 'trigger';
     loggingInterval?: string | null;
     logTrigger?: ResLink | null;
-    name?: string;
+    name?: string | null;
     onChangeExpiry?: string | null;
     publicId: string;
     retentionPolicy?: string | null;

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

@@ -1,4 +1,4 @@
-import { ResLink } from './res-link';
+import type { ResLink } from './res-link';
 export interface AgentEdgeAppInstanceServiceOverrides {
     environment?: string | null;
 }

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

@@ -1,5 +1,5 @@
 import type { AgentEdgeAppInstanceService } from './agent-edge-app-instance-service';
-import { EdgeAppFile } from './edge-app-file';
+import type { EdgeAppFile } from './edge-app-file';
 import type { ResLink } from './res-link';
 export interface EdgeAppInstanceDeploymentProgress {
     files: EdgeAppInstanceProgress;
@@ -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-app-config-resource.d.ts

@@ -1,4 +1,4 @@
-import { ResLink } from './res-link';
+import type { ResLink } from './res-link';
 export interface AssetAppConfigResource {
     config?: ResLink;
     publicId: string;

package/dist/types/ixapi/resources/asset-app-config.d.ts

@@ -1,5 +1,5 @@
 import type { ResLink } from './res-link';
-import { AssetAppConfigResource } from './asset-app-config-resource';
+import type { AssetAppConfigResource } from './asset-app-config-resource';
 export interface AssetAppConfig {
     app?: ResLink;
     asset?: ResLink;

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

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

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

@@ -1,4 +1,4 @@
-import { ResLink } from './res-link';
+import type { ResLink } from './res-link';
 export interface ControlledDeviceMembership {
     publicId: string;
     controlledDevice?: ResLink;

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

@@ -1,6 +1,6 @@
-import { Agent } from './agent';
-import { ControlledDeviceMembership } from './controlled-device-membership';
-import { ResLink } from './res-link';
+import type { Agent } from './agent';
+import type { ControlledDeviceMembership } from './controlled-device-membership';
+import type { ResLink } from './res-link';
 export interface ControlledDevice {
     agent?: ControlledDeviceAgentReference | null;
     memberships?: ControlledDeviceMembership[];

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/edge-app.d.ts

@@ -1,4 +1,4 @@
-import { CompanyReference } from './company';
+import type { CompanyReference } from './company';
 export interface EdgeApp {
     company?: CompanyReference | null;
     description?: string | null;

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,9 +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?: {
+        /** 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/page-component-template-manifest.d.ts

@@ -1,5 +1,5 @@
 import type { ResLink } from './res-link';
-import { ComponentInput } from '../../component-input';
+import type { ComponentInput } from '../../component-input';
 export interface PageComponentTemplateManifest {
     /** @deprecated */
     author?: string | null;

package/dist/types/ixapi/resources/page-link-group.d.ts

@@ -2,6 +2,7 @@ import type { ResLink } from './res-link';
 export interface PageLinkGroup {
     agent?: ResLink | null;
     asset?: ResLink | null;
+    menuItem?: ResLink | null;
     name?: string;
     publicId: string;
 }

package/dist/types/ixapi/resources/page-link.d.ts

@@ -7,6 +7,7 @@ export interface PageLink {
     audience?: Audience | null;
     custom?: {};
     group?: PageLinkGroup | null;
+    menuItem?: ResLink | null;
     order?: number;
     page?: ResLink;
     publicId: string;

package/dist/types/ixapi/resources/page-version.d.ts

@@ -1,7 +1,7 @@
 import type { PageComponent } from './page-component';
 import type { PagePage } from './page-page';
 import type { ResLink } from './res-link';
-import { UserReference } from './user';
+import type { UserReference } from './user';
 export interface PageVersion {
     components?: PageComponent[];
     createdBy?: UserReference | null;

package/dist/types/ixapi/resources/pipeline-function.d.ts

@@ -1,4 +1,4 @@
-import { CompanyReference } from './company';
+import type { CompanyReference } from './company';
 export interface PipelineFunction {
     publicId: string;
     name?: string;

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

@@ -7,7 +7,7 @@ import type { ResourceDataResult } from './resource-data-result';
 import type { ResourceDataUpdate, ResourceDataUpdateSelector } from './resource-data-update';
 interface ResultDataMap {
     Agent: ResourceData.Agent;
-    AgentDataTag: ResourceData.AgentDataTag;
+    AgentDataTagList: ResourceData.AgentDataTag[];
     AppConfig: ResourceData.AppConfig;
     Asset: ResourceData.Asset;
     AssetAppConfig: ResourceData.AssetAppConfig;
@@ -18,6 +18,7 @@ interface ResultDataMap {
     LicenceList: ResourceData.Licence[];
     MyCompany: ResourceData.MyCompany;
     MyUser: ResourceData.MyUser;
+    Page: ResourceData.Page;
     PagePage: ResourceData.PagePage;
     PageVersion: ResourceData.PageVersion;
     UserList: ResourceData.User[];
@@ -33,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-query.d.ts

@@ -1,5 +1,5 @@
 /** @module ResourceDataQuery */
-export type ResourceDataQuerySelector = 'Agent' | 'AgentDataTag' | 'AppConfig' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'LicenceList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
+export type ResourceDataQuerySelector = 'Agent' | 'AgentDataTagList' | 'AppConfig' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'LicenceList' | 'MyCompany' | 'MyUser' | 'Page' | 'PagePage' | 'PageVersion' | 'UserList';
 export interface ResourceDataQuery<TSelector = ResourceDataQuerySelector> {
     /**
      * String reference unique to the query call made by the client.

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;
     }[];
@@ -218,6 +218,10 @@ interface MyUserResourceData {
     support?: boolean;
     unreadMessagesCount?: number;
 }
+interface PageResourceData {
+    applicationType?: 'sheet' | 'card' | 'report';
+    publicId: string;
+}
 interface PagePageResourceData {
     order?: number | null;
     publicId: string;
@@ -247,6 +251,7 @@ export declare namespace ResourceData {
     type Licence = LicenceResourceData;
     type MyCompany = MyCompanyResourceData;
     type MyUser = MyUserResourceData;
+    type Page = PageResourceData;
     type PagePage = PagePageResourceData;
     type PageVersion = PageVersionResourceData;
     type User = UserResourceData;

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.21.0-next.2",
+  "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": [