@ixon-cdk/types 1.2.0-next.10

package/README.md

@@ -0,0 +1,3 @@
+# IXON Component Development Kit Types
+
+This package can be used with the IXON Component Development Kit (CDK). It contains Type Definitions that can be used when you develop custom components using [TypeScript](https://www.typescriptlang.org/).

package/dist/component-devkit/src/types/src/index.d.ts

@@ -0,0 +1,7 @@
+export * from '../../../../types/component-context';
+export * from '../../../../types/backend-component';
+export * from '../../../../types/component-context';
+export * from '../../../../types/ixapi';
+export * from '../../../../types/logging-data';
+export * from '../../../../types/resource-data';
+export * from '../../../../types/vpn-client';

package/dist/types/backend-component/backend-component-call.d.ts

@@ -0,0 +1,18 @@
+/** @module BackendComponentCall */
+export interface BackendComponentCall {
+    /**
+     * String reference unique to the query call made by the client
+     * @ignore
+     */
+    _clientRef?: string;
+    /**
+     * The name of the function you want to call
+     */
+    functionName: string;
+    /**
+     * Arguments you want to pass to the function
+     */
+    functionArguments?: {
+        [key: string]: any;
+    };
+}

package/dist/types/backend-component/backend-component-client.d.ts

@@ -0,0 +1,12 @@
+/** @module BackendComponentClient */
+import type { BackendComponentResult } from './backend-component-result';
+export interface BackendComponentClient {
+    destroy(): void;
+    /**
+     * @param {string} functionName The name of the Custom Backend Component function you want to call
+     * @param {{ [key: string]: any }} functionArguments The arguments you want to pass to the Custom Backend Component function
+     */
+    call(functionName: string, functionArguments?: {
+        [key: string]: any;
+    }): Promise<BackendComponentResult>;
+}

package/dist/types/backend-component/backend-component-result.d.ts

@@ -0,0 +1,6 @@
+/** @module BackendComponentResult */
+import type { BackendComponentCall } from './backend-component-call';
+export interface BackendComponentResult {
+    call: BackendComponentCall;
+    data: any;
+}

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

@@ -0,0 +1,3 @@
+export * from './backend-component-call';
+export * from './backend-component-client';
+export * from './backend-component-result';

package/dist/types/component-context/app-data.d.ts

@@ -0,0 +1,32 @@
+export interface ComponentContextAppData {
+    accessToken: {
+        publicId: string | null;
+        /**
+         * Used as a bearer token for authenticating API-requests
+         */
+        secretId: string | null;
+    };
+    /**
+     * The API ID of the application the component is used in
+     */
+    apiAppId: string;
+    /**
+     * The version of the IXON API used.
+     */
+    apiVersion: string;
+    company: {
+        publicId: string;
+    };
+    /**
+     * The language of the platform.
+     */
+    language: string;
+    /**
+     * The locale of the platform as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag)
+     */
+    locale: string;
+    /**
+     * The time zone of the platform.
+     */
+    timeZone: string;
+}

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

@@ -0,0 +1,181 @@
+/** @module ComponentContext */
+import type { BackendComponentClient } from '../backend-component';
+import type { LoggingDataClient, LoggingDataTimeRange } from '../logging-data';
+import type { ResourceDataClient } from '../resource-data';
+import type { VpnClientStatus } from '../vpn-client';
+import type { ComponentContextAppData } from './app-data';
+import type { Tooltip, TooltipOptions } from './tooltip';
+export type { ComponentContextAppData } from './app-data';
+export type { Tooltip, TooltipOptions } from './tooltip';
+export * from './input';
+/**
+ * The Component Context provides access to the component's inputs, the page's time range, to the LoggingDataClient and ResourceDataClient and to other application data.
+ */
+export interface ComponentContext<ComponentContextInputs extends object = {
+    [key: string]: any;
+}> {
+    /**
+     * Application data.
+     */
+    appData: ComponentContextAppData;
+    /**
+     * The component's base URL. This can be used to compose an absolute URL to a static component asset.
+     *
+     * For example:
+     *
+     * ```
+     * new URL('./static/image.png', context.componentBaseUrl).href;
+     * ```
+     *
+     * @experimental
+     */
+    componentBaseUrl: string;
+    /**
+     * True if `destroy` is called and has destroyed all clients.
+     */
+    destroyed: boolean;
+    /**
+     * 'edit' when the component is used in the Studio, else 'view'.
+     */
+    mode: 'edit' | 'view';
+    /**
+     * Values for the inputs declared in the components
+     * [manifest file](https://developer.ixon.cloud/docs/manifest-file)
+     */
+    inputs: ComponentContextInputs;
+    /**
+     * Values for the inputs declared in the components
+     * [manifest file](https://developer.ixon.cloud/docs/manifest-file) as a Javascript Map.
+     */
+    inputMap: Map<string, any>;
+    /**
+     * Snapshot of the current time range
+     */
+    timeRange: LoggingDataTimeRange;
+    /**
+     * If the time range is adjustable.
+     */
+    timeRangeIsAdjustable: boolean;
+    /**
+     * Snapshot of the current VPN client status.
+     */
+    vpnClientStatus: VpnClientStatus | null;
+    /**
+     * Called when the time range is changed
+     */
+    ontimerangechange: ((newTimeRange: LoggingDataTimeRange) => any) | null;
+    /**
+     * Called when the VPN client status changes
+     */
+    onvpnclientstatuschange: ((newStatus: VpnClientStatus | null) => any) | null;
+    /**
+     * Creates a client to call backend components.
+     *
+     * Every time this method is called, a new client is created.
+     *
+     * @experimental This feature is in development. It might not be supported in your environment
+     * and might also be removed without prior notice.
+     * @ignore
+     */
+    createBackendComponentClient(): BackendComponentClient;
+    /**
+     * Creates a client to retrieve logging data.
+     *
+     * Every time this method is called, a new client is created.
+     */
+    createLoggingDataClient(): LoggingDataClient;
+    /**
+     * Creates a client to retrieve resource data.
+     *
+     * Every time this method is called, a new client is created.
+     */
+    createResourceDataClient(): ResourceDataClient;
+    /**
+     * Attaches a tooltip on the target element.
+     *
+     * @param target the target element
+     * @param options configures the tooltip message and other (optional) properties
+     * @returns returns the tooltip instance
+     *
+     * @experimental
+     */
+    createTooltip(target: HTMLElement, options: TooltipOptions): Tooltip;
+    /**
+     * Destroy the clients associated to this context and destroy the context.
+     */
+    destroy(): void;
+    /**
+     * Get the endpoint for a resource, the rel.
+     *
+     * @param rel The name of the resource, see [the reference](https://developer.ixon.cloud/reference)
+     * for all resource relations.
+     * @param params Extra query parameters, see [the reference](https://developer.ixon.cloud/reference)
+     * for all the URL and query paramaters that can be used for a specific resource.
+     */
+    getApiUrl(rel: string, params?: {
+        [param: string]: string;
+    }): string;
+    /**
+     * Use this method to navigate to a specific page in the portal, for example the VNC-viewer.
+     * Don't use this method to navigate to navigate outside the Portal.
+     *
+     * @param url The URL to navigate to, don't include the host.
+     */
+    navigateByUrl(url: string): void;
+    /**
+     * Save a file.
+     *
+     * @param data the file data to save
+     * @param fileName the name of the file
+     */
+    saveAsFile(data: string | Blob, fileName: string): void;
+    /**
+     * Set a new time range. Check `timeRangeIsAdjustable` to verify the time range is adjustable
+     *
+     * @param timeRange The time range to change to
+     */
+    setTimeRange(timeRange: LoggingDataTimeRange): void;
+    /**
+     * Open a dialog with VPN status details for an agent.
+     *
+     * @param agentId The agent to show VPN status info for
+     */
+    showVpnStatusDetails(agentId: string): void;
+    /**
+     * Tests whether the currently logged in user has VPN access to the Agent with the given {@code agentId}.
+     * @param agentId the Agent ID
+     * @returns true if the user has access, false otherwise
+     */
+    testVpnAccess(agentId: string): boolean;
+    /**
+     * Connects or disconnects the VPN-client
+     *
+     * @param agentId The public ID of the agent to connect to or disconnect from.
+     */
+    toggleVpn(agentId: string): void;
+    /**
+     * Translate a key to the users language.
+     *
+     * @param key
+     * @param interpolateParams
+     */
+    translate(key: string | Array<string>, interpolateParams?: Object): string | any;
+}
+/**
+ * A ComponentContext factory is injected into each component. Through this factory, a ComponentContext instance can be constructed.
+ */
+export type ComponentContextFactory = <T extends object = {
+    [key: string]: any;
+}>(options?: ComponentContextOptions) => ComponentContext<T>;
+export interface ComponentContextOptions {
+    /**
+     * Migrate the inputs from an earlier version to the current version of the component.
+     *
+     * @param inputs the inputs of this component for an earlier version of the component
+     * @param version the version of the component for which the inputs were for, or null if the version is unknown
+     * @returns the inputs for the current version of the component
+     */
+    migrateInputs?: (inputs: any, version: string | null) => {
+        [key: string]: any;
+    };
+}

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

@@ -0,0 +1,19 @@
+export interface ComponentContextAggregatedMetricInput {
+    aggregator: string;
+    decimals: number | null;
+    factor: number | null;
+    selector: string;
+    transform: null;
+    unit: string | null;
+}
+export interface ComponentContextLiveMetricInput {
+    decimals: number | null;
+    factor: number | null;
+    selector: string;
+    unit: string | null;
+}
+export type ComponentContextInput = ComponentContextInputGroup | string | number | ComponentContextAggregatedMetricInput | ComponentContextLiveMetricInput | null;
+export type ComponentContextInputGroup = ComponentContextInputs;
+export type ComponentContextInputs = {
+    [key: string]: ComponentContextInput | ComponentContextInputGroup;
+};

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

@@ -0,0 +1,14 @@
+/** @module Tooltip */
+export interface Tooltip {
+    destroy(): void;
+    disable(): void;
+    enable(): void;
+    setMessage(message: string): void;
+}
+export interface TooltipOptions {
+    disabled?: boolean;
+    hideDelay?: number;
+    message: string;
+    position?: 'top' | 'bottom' | 'left' | 'right';
+    showDelay?: number;
+}

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

@@ -0,0 +1,12 @@
+export interface IxApiError {
+    listIndex?: number;
+    message: string;
+    propertyName?: string;
+}
+export type IxApiErrorResponse = IxApiResponse<IxApiError[]>;
+export interface IxApiResponse<T> {
+    data: T;
+    moreAfter?: string | null;
+    status?: 'success' | 'error';
+    type?: string;
+}

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

@@ -0,0 +1,8 @@
+export * from './logging-data-blob';
+export * from './logging-data-client';
+export * from './logging-data-metric';
+export * from './logging-data-query-options';
+export * from './logging-data-query';
+export * from './logging-data-query';
+export * from './logging-data-time-range';
+export * from './logging-data-value';

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

@@ -0,0 +1,9 @@
+/** @module LoggingDataBlob */
+import type { LoggingDataQueryRef } from './logging-data-query-ref';
+/** The result of a single export request. */
+export interface LoggingDataBlob {
+    /** Indicates the queries that are included in the blob. */
+    queryRefs: LoggingDataQueryRef[];
+    /** Contents of the export response. */
+    blob: Blob;
+}

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

@@ -0,0 +1,30 @@
+/** @module LoggingDataClient */
+import type { LoggingDataBlob } from './logging-data-blob';
+import type { LoggingDataMetric } from './logging-data-metric';
+import type { LoggingDataQuery } from './logging-data-query';
+import type { LoggingDataQueryOptions } from './logging-data-query-options';
+export interface LoggingDataClient {
+    /**
+     * Destroy the client. Always call this when the client is not used anymore. When the context is
+     * destroyed, this is called automatically
+     */
+    destroy(): void;
+    /**
+     * Starts a query for logging data. This method can be used for historic and live data depending
+     * on the selector.
+     *
+     * @returns {function()} Returns a deregistration function for the listener.
+     */
+    query(query: LoggingDataQuery, listener: (result: LoggingDataMetric[]) => any): () => void;
+    query(queries: LoggingDataQuery[], listener: (results: LoggingDataMetric[][]) => any): () => void;
+    query<T extends LoggingDataQueryOptions>(queryOptions: T, 
+    /**
+     * Depending on the `format` in the query options, the query listener result has a specific type.
+     *
+     * - If `format` is `'csv'`, the result type is `LoggingDataBlob`
+     * - Otherwise, the result type is `LoggingDataMetric[][]`
+     */
+    listener: (results: T extends {
+        format: 'csv';
+    } ? LoggingDataBlob : LoggingDataMetric[][]) => void): () => void;
+}

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

@@ -0,0 +1,17 @@
+/** @module LoggingDataMetric */
+import type { LoggingDataQueryRef } from './logging-data-query-ref';
+import type { LoggingDataValue } from './logging-data-value';
+export interface LoggingDataMetric {
+    /**
+     * The ref provided in the query, else this is generated
+     */
+    queryRef: LoggingDataQueryRef;
+    /**
+     * The time the value was logged
+     */
+    time: number;
+    /**
+     * The queries result value
+     */
+    value: LoggingDataValue;
+}

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

@@ -0,0 +1,29 @@
+/** @module LoggingDataQueryOptions */
+import type { LoggingDataQuery } from './logging-data-query';
+export interface LoggingDataQueryOptions {
+    /**
+     * Specifies the delimiter used to separate columns in the returned CSV data.
+     *
+     * Only applicable for format `'csv'`
+     *
+     * Defaults to `'comma'`
+     * */
+    csvDelimiter?: 'comma' | 'tab' | 'semicolon';
+    queries: LoggingDataQuery[];
+    /**
+     * Specifies the format of the returned metrics.
+     * - If `format` is `'metrics'`, the listener is called with `LoggingDataMetric[][]`.
+     * - If `format` is `'csv'`, the listener is called at most once with `LoggingDataBlob`.
+     *
+     * Defaults to `'metrics'`
+     */
+    format?: 'csv' | 'metrics';
+    /**
+     * Specifies whether the query listener should be automatically removed after it gets invoked.
+     *
+     * Not applicable for format `'csv'`, because this format implies the automatic listener removal after invocation behaviour.
+     *
+     * Defaults to `false`
+     */
+    once?: boolean;
+}

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

@@ -0,0 +1,8 @@
+/** @module LoggingDataQueryRef */
+import type { LoggingDataQuery } from './logging-data-query';
+export interface LoggingDataQueryRef {
+    query: LoggingDataQuery;
+    variable?: any;
+    tag?: any;
+    cancel(): void;
+}

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

@@ -0,0 +1,103 @@
+/** @module LoggingDataQuery */
+export interface LoggingDataQuery {
+    /**
+     * String reference unique to the query call made by the client
+     * @ignore
+     */
+    _clientRef?: string;
+    /**
+     * Timestamp for when the query was dispatched by the client
+     * @ignore
+     */
+    _timeStamp?: number;
+    /**
+     * Number of decimals to be returned
+     */
+    decimals?: number;
+    /**
+     * Whether or not you want to query for extra data-points, one before the start date and one beyond the end date (if they exist).
+     */
+    extendedBoundary?: boolean;
+    /**
+     * The factor to multiply the value by
+     */
+    factor?: number;
+    /**
+     * Used to override the global time-range for this specific query
+     *
+     * For example 2019-01-01T00:00:00Z
+     */
+    from?: string;
+    /**
+     * How many values should be fetched. The postAggr is applied to reduce the set of points to the limit.
+     */
+    limit?: number;
+    /**
+     * Starting point for returned values
+     *
+     * Must be null if postAggr is set
+     */
+    offset?: number;
+    /**
+     * The order to order datapoints by
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * Aggregrator for aggregation after data storage
+     *
+     * Must be null if offset is set
+     */
+    postAggr?: Aggregrator;
+    /**
+     * Apply a transform. Only applies when postAggr is `'last'`.
+     *
+     * `'difference'` takes the difference between the last value in a bucket and the bucket before it.
+     */
+    postTransform?: Transform | null;
+    /**
+     * When omitted, the pre-aggregator is determined automatically based on a couple of factors, but
+     * in most cases it defaults to "raw".
+     */
+    preAggr?: Aggregrator;
+    /**
+     * Reference to identify the value by. If this is not set, a unique reference is generated.
+     */
+    ref?: string;
+    /**
+     * The selector for getting data from a specific tag or variable. Can be used instead of tag or
+     * variable field
+     *
+     * Formatted as <dataSource>.<logType>.<logName> where <dataSource> is the name of the datas source,
+     * <logType> is 'tag' or 'variable' and <logName> is the slug of the tag or variable.
+     */
+    selector?: string;
+    /**
+     * Number of seconds between subsequent data-points
+     */
+    step?: number;
+    /**
+     * The tag to fetch the data from. Must be null if variable is set
+     */
+    tag?: {
+        publicId: string;
+    } | null;
+    /**
+     * Used to override the global time-range for this specific query
+     *
+     * For example 2019-01-01T23:59:59Z
+     */
+    to?: string;
+    /**
+     * The unit of the value
+     */
+    unit?: string;
+    /**
+     * The variable to fetch the data from. Must be null if tag is set
+     */
+    variable?: {
+        publicId: string;
+    } | null;
+}
+type Aggregrator = 'count' | 'distinct' | 'integral' | 'mean' | 'median' | 'mode' | 'spread' | 'stddev' | 'sum' | 'first' | 'last' | 'max' | 'min' | 'raw';
+type Transform = 'difference';
+export {};

package/dist/types/logging-data/logging-data-time-range.d.ts

@@ -0,0 +1,7 @@
+/** @module LoggingDataTimeRange */
+export interface LoggingDataTimeRange {
+    /** UNIX time value in milliseconds. */
+    from: number;
+    /** UNIX time value in milliseconds. */
+    to: number;
+}

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

@@ -0,0 +1,9 @@
+/** @module LoggingDataValue */
+export interface LoggingDataValue {
+    setDecimals(newDecimals: number): void;
+    /** @deprecated */
+    setFactor(newFactor: number): void;
+    setUnit(newUnit: string): void;
+    getValue(): boolean | number | string | null;
+    toString(): string;
+}

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

@@ -0,0 +1,4 @@
+export * from './resource-data-client';
+export * from './resource-data-query';
+export * from './resource-data-result';
+export * from './resource-data';

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

@@ -0,0 +1,57 @@
+/** @module ResourceDataClient */
+import type { ResourceDataQuery, ResourceDataQuerySelector, ResourceDataTemplateQuery } from './resource-data-query';
+import type { ResourceDataResult } from './resource-data-result';
+import type { ResourceData } from './resource-data';
+interface ResultDataMap {
+    Agent: ResourceData.Agent;
+    Asset: ResourceData.Asset;
+    Branding: ResourceData.Branding;
+    CustomPropertyList: ResourceData.CustomProperty[];
+    GroupList: ResourceData.Group[];
+    MyUser: ResourceData.MyUser;
+    PagePage: ResourceData.PagePage;
+    PageVersion: ResourceData.PageVersion;
+}
+export interface ResourceDataClient {
+    destroy(): void;
+    /**
+     * @returns {function()} Returns a deregistration function for the listener.
+     */
+    query<T extends ResourceDataQuerySelector>(query: ResourceDataQuery<T> | [ResourceDataQuery<T>], listener: (results: [ResourceDataResult<ResultDataMap[T]>]) => any): () => void;
+    query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector>(query: [ResourceDataQuery<T1>, ResourceDataQuery<T2>], listener: (results: [ResourceDataResult<ResultDataMap[T1]>, ResourceDataResult<ResultDataMap[T2]>]) => any): () => void;
+    query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector, T3 extends ResourceDataQuerySelector>(query: [ResourceDataQuery<T1>, ResourceDataQuery<T2>, ResourceDataQuery<T3>], listener: (results: [
+        ResourceDataResult<ResultDataMap[T1]>,
+        ResourceDataResult<ResultDataMap[T2]>,
+        ResourceDataResult<ResultDataMap[T3]>
+    ]) => any): () => void;
+    query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector, T3 extends ResourceDataQuerySelector, T4 extends ResourceDataQuerySelector>(query: [ResourceDataQuery<T1>, ResourceDataQuery<T2>, ResourceDataQuery<T3>], listener: (results: [
+        ResourceDataResult<ResultDataMap[T1]>,
+        ResourceDataResult<ResultDataMap[T2]>,
+        ResourceDataResult<ResultDataMap[T3]>,
+        ResourceDataResult<ResultDataMap[T4]>
+    ]) => any): () => void;
+    query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector, T3 extends ResourceDataQuerySelector, T4 extends ResourceDataQuerySelector>(query: [ResourceDataQuery<T1>, ResourceDataQuery<T2>, ResourceDataQuery<T3>, ResourceDataQuery<T4>], listener: (results: [
+        ResourceDataResult<ResultDataMap[T1]>,
+        ResourceDataResult<ResultDataMap[T2]>,
+        ResourceDataResult<ResultDataMap[T3]>,
+        ResourceDataResult<ResultDataMap[T4]>
+    ]) => any): () => void;
+    query<T1 extends ResourceDataQuerySelector, T2 extends ResourceDataQuerySelector, T3 extends ResourceDataQuerySelector, T4 extends ResourceDataQuerySelector, T5 extends ResourceDataQuerySelector>(query: [
+        ResourceDataQuery<T1>,
+        ResourceDataQuery<T2>,
+        ResourceDataQuery<T3>,
+        ResourceDataQuery<T4>,
+        ResourceDataQuery<T5>
+    ], listener: (results: [
+        ResourceDataResult<ResultDataMap[T1]>,
+        ResourceDataResult<ResultDataMap[T2]>,
+        ResourceDataResult<ResultDataMap[T3]>,
+        ResourceDataResult<ResultDataMap[T4]>,
+        ResourceDataResult<ResultDataMap[T5]>
+    ]) => any): () => void;
+    /**
+     * @returns {function()} Returns a deregistration function for the listener.
+     */
+    render(templates: ResourceDataTemplateQuery[], listener: (results: string[]) => void): () => void;
+}
+export {};

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

@@ -0,0 +1,36 @@
+/** @module ResourceDataQuery */
+export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyUser' | 'PagePage' | 'PageVersion';
+export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
+    /**
+     * String reference unique to the query call made by the client
+     * @ignore
+     */
+    _clientRef?: string | string[];
+    /**
+     * List of fields to get from the resource, see the
+     * [developer documentation](https://developer.ixon.cloud/docs/using-the-resourcedataclient) 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
+     */
+    selector: T;
+}
+export interface ResourceDataTemplateQuery {
+    /**
+     * String reference unique to the query call made by the client
+     * @ignore
+     */
+    _clientRef?: string | 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.
+     *
+     * If omitted, an empty object is returned
+     */
+    template: string;
+}

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

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

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

@@ -0,0 +1,142 @@
+interface AgentResourceData {
+    activeVpnSession?: {
+        rscServer?: {
+            name?: string;
+            publicId: string;
+        } | null;
+        vpnAddress?: string;
+    } | null;
+    connectedUsers?: {
+        name?: string;
+        publicId: string;
+    }[];
+    custom?: Record<string, any>;
+    dataSources?: {
+        name?: string | null;
+        publicId: string;
+        slug?: string | null;
+    }[];
+    description?: string | null;
+    lastSeenAgentUserAgent?: {
+        firmwareVersion?: string | null;
+        hardware?: string | null;
+        hardwareVersion?: string | null;
+        publicId: string;
+    } | null;
+    location?: {
+        name?: string | null;
+    } | null;
+    loggingMdrServer?: {
+        name?: string;
+        publicId: string;
+    } | null;
+    loggingMqttChangedOn?: string | null;
+    macAddress?: string | null;
+    mdrServer?: {
+        name?: string;
+        publicId: string;
+    } | null;
+    memberships?: {
+        group?: {
+            publicId: string;
+        };
+        publicId: string;
+    }[];
+    mqttChangedOn?: string | null;
+    name?: string;
+    publicId: string;
+    rateLimiting?: {
+        configMqttCommandCounter?: number;
+        configMqttCommandLastHit?: string;
+        configMqttCommandLimit?: 'soft' | 'hard' | 'lock' | null;
+        configMqttDataCounter?: number;
+        configMqttDataLastHit?: string;
+        configMqttDataLimit?: 'soft' | 'hard' | 'lock' | null;
+        configOpenvpnCounter?: number;
+        configOpenvpnLastHit?: string;
+        configOpenvpnLimit?: 'soft' | 'hard' | 'lock' | null;
+    };
+    serialNumber?: string | null;
+    servers?: {
+        custom?: Record<string, any>;
+        name?: string;
+        publicId: string;
+        serviceGroup?: string | null;
+        type?: 'http' | 'rdp' | 'vnc' | 'websocket';
+        visibleInMobileApp?: boolean;
+    }[];
+    type?: {
+        name?: string;
+        publicId: string;
+    };
+    vpnVisibleInMobileApp?: boolean;
+}
+interface AssetResourceData {
+    custom?: Record<string, any>;
+    description?: string | null;
+    memberships?: {
+        group?: {
+            publicId: string;
+        };
+        publicId: string;
+    }[];
+    name?: string;
+    publicId: string;
+    resourceVariant?: {
+        publicId: string;
+    };
+}
+interface BrandingResourceData {
+    logo?: string | null;
+    publicId: string;
+    theme?: {
+        logoHasBackgroundColor?: boolean;
+    } | null;
+}
+interface CustomPropertyResourceData {
+    flags?: string[];
+    name?: string;
+    publicId: string;
+    resourceType?: string;
+    resourceVariant?: string | null;
+    scopeType?: 'glb' | 'app' | 'sct' | 'usr' | 'com';
+    slug?: string;
+}
+interface GroupResourceData {
+    name?: string | null;
+    publicId: string;
+    type?: {
+        name?: string;
+        order?: number;
+        publicId: string;
+    } | null;
+}
+interface MyUserResourceData {
+    custom?: Record<string, any>;
+    name?: string;
+    publicId: string;
+    unreadMessagesCount?: number;
+}
+interface PagePageResourceData {
+    order?: number | null;
+    publicId: string;
+}
+interface PageVersionResourceData {
+    pagePages?: {
+        order?: number | null;
+        publicId: string;
+    }[];
+    publicId: string;
+    title?: string | null;
+}
+export declare namespace ResourceData {
+    type Agent = AgentResourceData;
+    type Asset = AssetResourceData;
+    type Branding = BrandingResourceData;
+    type CustomProperty = CustomPropertyResourceData;
+    type Group = GroupResourceData;
+    type MyUser = MyUserResourceData;
+    type PagePage = PagePageResourceData;
+    type PageVersion = PageVersionResourceData;
+}
+export {};

package/dist/types/vpn-client/index.d.ts

@@ -0,0 +1,19 @@
+export interface VpnClientStatus {
+    activeRequest: VpnClientStatusActiveRequest | '';
+    status: 'idle' | 'connecting' | 'connected';
+}
+export interface VpnClientStatusActiveRequest {
+    agentId: string;
+    companyId: string;
+    controllerId: string;
+    steps: VpnClientStatusActiveRequestStep[];
+}
+export interface VpnClientStatusActiveRequestStep {
+    name: string;
+    description: string;
+    status: VpnClientStatusActiveRequestStatus;
+}
+export interface VpnClientStatusActiveRequestStatus {
+    code: string;
+    message: string;
+}

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@ixon-cdk/types",
+  "version": "1.2.0-next.10",
+  "description": "",
+  "main": "./dist/component-devkit/src/types/src/index.d.ts",
+  "author": "",
+  "license": "ISC",
+  "files": [
+    "dist"
+  ]
+}