@ixon-cdk/types 1.2.0-next.2 → 1.2.0-next.3

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]: string;
+    };
+}

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]: string}} functionArguments The arguments you want to pass to the Custom Backend Component function
+     */
+    call(functionName: string, functionArguments?: {
+        [key: string]: string;
+    }): 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,169 @@
+/** @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;
+    /**
+     * 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/ixapi/resources/agent-config.d.ts

@@ -0,0 +1,115 @@
+import type { ResLink } from './res-link';
+export interface AgentConfig {
+    agent?: ResLink;
+    configFileReported?: string | null;
+    configFileReportedWlanKeyEnabled?: boolean;
+    configFileServer?: string | null;
+    configPushedOn?: string | null;
+    configReportedOn?: string | null;
+    /** @deprecated */
+    configsAreDifferent?: boolean;
+    differentConfigs?: boolean;
+    differentStewardConfigs?: boolean;
+    /** NOTE: This public ID is identical to the public ID of its linked agent. */
+    publicId: string;
+    routerAdditionalSubnets?: AgentRouterAdditionalSubnet[];
+    routerDisplay?: AgentConfigRouterDisplay | null;
+    routerLan?: AgentConfigRouterLan | null;
+    routerPortForwards?: AgentRouterPortForward[];
+    routerWan?: AgentConfigRouterWan | null;
+    stewardConfigFileReported?: string;
+    stewardConfigFileServer?: string;
+    stewardConfigReportedOn?: string | null;
+    /** @deprecated */
+    stewardConfigsAreDifferent?: boolean;
+}
+export interface AgentRouterAdditionalSubnet {
+    agent?: ResLink;
+    gatewayAddress?: string;
+    networkAddress?: string;
+    networkMask?: string;
+    publicId: string;
+}
+export interface AgentConfigRouterDisplay {
+    agent?: ResLink;
+    lockEnabled?: boolean;
+    lockCode?: string | null;
+}
+export interface AgentConfigRouterLan {
+    agent?: ResLink;
+    bacnetBbmd?: string[] | null;
+    dhcpServerEnabled?: boolean;
+    dhcpServerRangeFrom?: string;
+    dhcpServerRangeTo?: string;
+    forwardLanWan?: AgentConfigRouterForwardLanWan;
+    gatewayLessRouting?: boolean;
+    ipAddress?: string;
+    netMask?: string;
+    network?: string;
+    udpBroadcastRelayPort?: number[] | null;
+    wlanChannel?: number | null /** range between 1-14 */;
+    wlanEnable?: boolean | null;
+    wlanSsid?: string | null;
+    wlanKey?: string | null;
+}
+export type AgentConfigRouterForwardLanWan = 'both' | 'private' | 'public' | 'neither';
+export interface AgentRouterPortForward {
+    agent?: ResLink;
+    externalPort?: number;
+    interface?: 'VPN' | 'WAN';
+    publicId: string;
+    targetIpAddress?: string;
+    targetPort?: number;
+}
+export interface AgentConfigRouterWan {
+    /** @deprecated */
+    '3gApn'?: string | null;
+    /** @deprecated */
+    '3gPincode'?: string | null;
+    /** @deprecated */
+    '3gTrackInterval'?: number;
+    /** @deprecated */
+    '3gTrackIps'?: string[];
+    agent?: ResLink;
+    cellularApn?: string | null;
+    cellularMtu?: number | null;
+    cellularPincode?: string | null;
+    cellularTrackInterval?: number;
+    cellularTrackIps?: string[];
+    digitalInputMode?: AgentConfigRouterWanDigitalInputMode;
+    dnsServer?: string | null /** @depricated */;
+    dnsServers?: string[] | null;
+    httpProxyAddress?: string | null;
+    httpProxyAuthentication?: 'none' | 'basic' | 'ntlm' | null;
+    httpProxyIsSocks5?: boolean | null;
+    httpProxyPassword?: string | null /** @hidden */;
+    httpProxyPort?: number | null;
+    httpProxyUsername?: string | null;
+    ipAddress?: string | null;
+    ipGateway?: string | null;
+    ipNetMask?: string | null;
+    ipUseDhcp?: boolean;
+    multiwanPolicy?: AgentConfigRouterMultiwanPolicy;
+    wanTrackInterval?: number;
+    wanTrackIps?: string[];
+    wlanDnsServers?: string[] | null;
+    wlanIpAddress?: string | null;
+    wlanIpGateway?: string | null;
+    wlanIpNetMask?: string | null;
+    wlanIpUseDhcp?: boolean | null;
+    wlanKey?: string | null /** @hidden */;
+    wlanSsid?: string | null;
+    wlanTrackInterval?: number;
+    wlanTrackIps?: string[];
+}
+export interface AgentConfigRouterWlan {
+    wlanKey?: string | null /** @hidden */;
+    wlanSsid?: string | null;
+    wlanDnsServers?: string[] | null;
+    wlanIpAddress?: string | null;
+    wlanIpGateway?: string | null;
+    wlanIpNetMask?: string | null;
+    wlanIpUseDhcp?: boolean | null;
+}
+export type AgentConfigRouterMultiwanPolicy = 'eth_cell_wifi' | 'cell_eth_wifi' | 'eth_wifi_cell' | 'wifi_eth_cell' | 'cell_wifi_eth' | 'wifi_cell_eth';
+export type AgentConfigRouterWanDigitalInputMode = 'disable_vpn_high' | 'disable_vpn_low' | 'disable_wan_high' | 'disable_wan_low' | null;

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

@@ -0,0 +1,11 @@
+import type { ResLink } from './res-link';
+export interface AgentDataCondition {
+    agent?: ResLink;
+    description?: string | null;
+    device?: ResLink;
+    /** For example: "#2 8 >=" (when variable 2 is greater than or equal to 8) */
+    formula?: string;
+    name?: string;
+    publicId: string;
+    source?: ResLink;
+}

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

@@ -0,0 +1,14 @@
+import type { DataProtocolAppliedUnion } from './data-protocol-applied';
+import type { ResLink } from './res-link';
+export interface AgentDataSource {
+    agent?: ResLink;
+    device?: ResLink;
+    disabled?: boolean;
+    name?: string | null;
+    port?: number | null;
+    protocol?: DataProtocolAppliedUnion;
+    publicId: string;
+    pullDelay?: number | null;
+    slug?: string | null;
+    valuesPerHour?: number;
+}

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

@@ -0,0 +1,22 @@
+import type { AgentDataCondition } from './agent-data-condition';
+import type { AgentDataVariable } from './agent-data-variable';
+import type { ResLink } from './res-link';
+export interface AgentDataTag {
+    agent?: ResLink;
+    aggregators?: string[];
+    device?: ResLink;
+    downsamplingInterval?: boolean;
+    /** When set to null will revert to "last", "shortest" and "longest". Only applicable to strings */
+    edgeAggregator?: 'min' | 'max' | 'shortest' | 'longest' | 'mean' | 'last' | 'increase' | null;
+    logEvent?: 'interval' | 'change' | 'trigger';
+    loggingInterval?: string;
+    logTrigger?: AgentDataCondition | null;
+    name?: string;
+    publicId: string;
+    retentionPolicy?: string;
+    slug?: string | null;
+    source?: ResLink;
+    onChangeExpiry?: string | null;
+    tagId?: number;
+    variable?: AgentDataVariable;
+}

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

@@ -0,0 +1,24 @@
+import type { ResLink } from './res-link';
+export interface AgentDataVariable {
+    address?: string;
+    agent?: ResLink;
+    device?: ResLink;
+    extraData?: any;
+    factor?: number | null;
+    forAlarming?: boolean;
+    forLogging?: boolean;
+    internalUse?: boolean;
+    maxStringLength?: number | null;
+    name?: string;
+    publicId: string;
+    signed?: boolean | null;
+    slug?: string | null;
+    source?: ResLink;
+    type?: AgentDataVariableType;
+    unit?: string | null;
+    updateable?: boolean;
+    variableId?: number;
+    width?: AgentDataVariableWidth | null;
+}
+export type AgentDataVariableType = 'bool' | 'int' | 'float' | 'str';
+export type AgentDataVariableWidth = '8' | '16' | '32' | '64';

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

@@ -0,0 +1,11 @@
+import type { ResLink } from './res-link';
+import type { AgentDataSource } from './agent-data-source';
+export interface AgentDevice {
+    agent?: ResLink;
+    customAddress?: string | null;
+    dataSources?: AgentDataSource[];
+    ipAddress?: string | null;
+    macAddress?: string | null;
+    name?: string | null;
+    publicId: string;
+}

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

@@ -0,0 +1,4 @@
+export interface AgentMdrServer {
+    name?: string;
+    publicId: string;
+}

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

@@ -0,0 +1,6 @@
+import type { ResLink } from './res-link';
+export interface AgentMembership {
+    agent?: ResLink;
+    group?: ResLink;
+    publicId: string;
+}

package/dist/types/ixapi/resources/agent-network-value.d.ts

@@ -0,0 +1,5 @@
+export interface AgentNetworkValue {
+    interface?: string;
+    name: string;
+    value: string[];
+}

package/dist/types/ixapi/resources/agent-router-vpn-access-rule.d.ts

@@ -0,0 +1,8 @@
+import type { ResLink } from './res-link';
+export interface AgentRouterVpnAccessRule {
+    agent?: ResLink;
+    audience?: ResLink;
+    ipAddress?: string;
+    netMask?: string;
+    publicId: string;
+}

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

@@ -0,0 +1,22 @@
+import type { ResLink } from './res-link';
+export interface AgentServer {
+    agent?: ResLink;
+    audience?: ResLink | null;
+    connectionQuality?: 'high' | 'normal' | 'low' | null;
+    custom?: {};
+    device?: ResLink;
+    landingPage?: string;
+    name?: string;
+    password?: string | null;
+    port?: number;
+    publicId: string;
+    readOnly?: boolean | null;
+    serviceGroup?: string | null;
+    template?: {
+        publicId?: string;
+    };
+    type?: 'http' | 'rdp' | 'vnc' | 'websocket';
+    username?: string | null;
+    useSsl?: boolean;
+    vncEncoding?: string | null;
+}

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

@@ -0,0 +1,3 @@
+import type { AgentLike } from './agent';
+export interface AgentTemplate extends AgentLike {
+}

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

@@ -0,0 +1,24 @@
+import type { AgentServer } from './agent-server';
+export interface AgentType {
+    additionalSubnets?: boolean;
+    allowDataPublishing?: boolean;
+    allowDemoDevice?: boolean;
+    allowReboot?: boolean;
+    allowTemplating?: boolean;
+    configPush?: boolean;
+    configFileFormat?: number;
+    customServers?: boolean;
+    deviceIdFormat?: string;
+    httpProxyPort?: number;
+    latestFirmwareFile?: any;
+    name?: string;
+    offlineConfiguration?: boolean;
+    publicId: string;
+    purchasePrice?: {
+        gratis?: boolean;
+    };
+    router?: boolean;
+    servers?: AgentServer[];
+    stunnelSupport?: boolean;
+    wanPortForwardings?: boolean;
+}