@ixon-cdk/types 1.3.0-next.0 → 1.3.0-next.1

package/README.md

@@ -1,3 +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/).
+This package can be used with the IXON Component Development Kit (CDK). It contains Type Definitions that can be used when you develop UI Components using [TypeScript](https://www.typescriptlang.org/).

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

@@ -2,6 +2,8 @@ export * from '../../../../types/component-context';
 export * from '../../../../types/backend-component';
 export * from '../../../../types/component-context';
 export * from '../../../../types/ixapi';
+export * from '../../../../types/ixapi/resources';
 export * from '../../../../types/logging-data';
+export * from '../../../../types/object-storage';
 export * from '../../../../types/resource-data';
 export * from '../../../../types/vpn-client';

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

@@ -1,6 +1,7 @@
 /** @module ComponentContext */
 import type { BackendComponentClient } from '../backend-component';
 import type { LoggingDataClient, LoggingDataTimeRange } from '../logging-data';
+import type { ObjectStorageClient } from '../object-storage';
 import type { ResourceDataClient } from '../resource-data';
 import type { VpnClientStatus } from '../vpn-client';
 import type { ComponentContextAppData } from './app-data';
@@ -88,6 +89,16 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * Every time this method is called, a new client is created.
      */
     createLoggingDataClient(): LoggingDataClient;
+    /**
+     * Creates a client to communicate with object storage.
+     *
+     * 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
+     */
+    createObjectStorageClient(): ObjectStorageClient;
     /**
      * Creates a client to retrieve resource data.
      *
@@ -100,8 +111,6 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * @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;
     /**
@@ -194,12 +203,23 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      */
     toggleVpn(agentId: string): void;
     /**
-     * Translate a key to the users language.
+     * Translate a key to the user's language.
      *
      * @param key
      * @param interpolateParams
+     * @param options
+     */
+    translate(key: string, interpolateParams?: Object, options?: TranslateOptions): string;
+    translate<T extends string>(key: T[], interpolateParams?: Object, options?: TranslateOptions): Record<T, string>;
+    translate<T extends string>(key: string | T[], interpolateParams?: Object, options?: TranslateOptions): string | Record<T, string>;
+}
+export interface TranslateOptions {
+    /**
+     * Indicates in which translation source or sources the translation will be looked up. When provided as a list, the order defines which source takes precedence over another.
+     *
+     * Defaults to `["custom", "global"]`
      */
-    translate(key: string | Array<string>, interpolateParams?: Object): string | any;
+    source?: 'custom' | 'global' | ('custom' | 'global')[];
 }
 /**
  * A ComponentContext factory is injected into each component. Through this factory, a ComponentContext instance can be constructed.

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

@@ -1,11 +1,13 @@
-export interface ComponentContextAggregatedMetricInput {
-    aggregator: string;
+export interface ComponentContextRawMetricInput {
     decimals: number | null;
     factor: number | null;
     selector: string;
     transform: null;
     unit: string | null;
 }
+export interface ComponentContextAggregatedMetricInput extends ComponentContextRawMetricInput {
+    aggregator: string;
+}
 export interface ComponentContextLiveMetricInput {
     decimals: number | null;
     factor: number | null;

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

@@ -0,0 +1,10 @@
+export interface AccessRecover {
+    emailAddress?: string;
+}
+export interface AccessRecoverCreate {
+    emailAddress: string;
+}
+export interface AccessRecoverFinish {
+    deleteAccessTokens: boolean;
+    newPassword: string;
+}

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

@@ -0,0 +1,29 @@
+import type { GeoLocation } from './location';
+import type { SsoAuthentication } from './sso-authentication';
+import type { MyUser } from './user';
+export interface AccessToken {
+    created?: {
+        ip?: string;
+        /** I.e. "2019-01-01T12:00:00Z" */
+        on?: string;
+        userAgent?: string;
+    };
+    /** I.e. "2019-01-01T12:00:00Z" */
+    expiresOn?: string;
+    geoLocation?: GeoLocation | null;
+    publicId: string;
+}
+export interface AccessTokenCreate {
+    /** In seconds. */
+    expiresIn: number;
+}
+export interface AccessTokenSsoCreate extends AccessTokenCreate {
+    ssoAuthentication: SsoAuthentication;
+}
+export interface AccessTokenCreateResponse {
+    /** I.e. "2019-01-01T12:00:00Z" */
+    expiresOn: string;
+    publicId: string;
+    secretId: string;
+    user: MyUser;
+}

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

@@ -0,0 +1,9 @@
+import type { ResLink } from './res-link';
+export interface AgentActivate {
+    couponCode?: string;
+    groups?: ResLink[];
+    licence?: ResLink;
+    name?: string;
+    publicId: string;
+    template?: ResLink;
+}

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

@@ -0,0 +1,125 @@
+import type { ResLink } from './res-link';
+export interface AgentConfig {
+    agent?: ResLink;
+    configFileReported?: string | null;
+    configFileReportedCellularPasswordEnabled?: boolean;
+    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;
+    cellularPassword?: string | null /** @hidden */;
+    cellularTrackInterval?: number;
+    cellularTrackIps?: string[];
+    cellularUsername?: string | null;
+    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 AgentConfigRouterCellular {
+    cellularApn?: string;
+    cellularPincode?: string | null;
+    cellularMtu?: number | null;
+    cellularUsername?: string | null;
+    cellularPassword?: string | null;
+}
+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-alarm.d.ts

@@ -0,0 +1,44 @@
+import type { ResLink } from './res-link';
+import type { User } from './user';
+export interface AgentDataAlarm {
+    agent?: ResLink;
+    audience?: ResLink | null;
+    autoAcknowledge?: boolean | null;
+    booleanNormalValue?: boolean | null;
+    device?: ResLink;
+    /** For example: "$2 8 >=" (when variable 2 is greater than or equal to 8) */
+    formula?: string;
+    name?: string;
+    /** In milliseconds */
+    offDelay?: number | null;
+    /** In milliseconds */
+    offResetDelay?: number | null;
+    /** In milliseconds */
+    onDelay?: number | null;
+    /** In milliseconds */
+    onResetDelay?: number | null;
+    operatorInstructionRtn?: string | null;
+    outOfService?: boolean | null;
+    publicId: string;
+    severity?: 'low' | 'medium' | 'high' | null;
+    source?: ResLink;
+    type?: 'unary' | 'boolean' | 'error_bits' | 'threshold' | 'rate_of_change' | 'bit_pattern';
+}
+export interface AgentDataAlarmOcc {
+    publicId: string;
+    alarm?: AgentDataAlarm;
+    occuredOn?: string;
+    acknowledged?: boolean | null;
+    acknowledgedOn?: string | null;
+    acknowledgedBy?: User | null;
+    comment?: string | null;
+    silenced?: boolean;
+    rtnOn?: string | null;
+    annunciations?: AgentDataAlarmOccAnn[];
+    stillActiveOn?: string | null;
+    rateLimitTill?: string | null;
+}
+export interface AgentDataAlarmOccAnn {
+    user?: User;
+    announcedOn?: string;
+}

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

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface AgentDataAlarmingAppActivate {
+    publicId: string;
+    couponCode?: string;
+    licence?: ResLink | null;
+    trial?: boolean;
+}

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

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface AgentDataLoggingAppActivate {
+    publicId: string;
+    couponCode?: string;
+    licence?: ResLink | null;
+    trial?: boolean;
+}

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

@@ -0,0 +1,6 @@
+export interface AgentDataMonitor {
+    darkTheme?: boolean;
+    layout?: object;
+    name?: string;
+    publicId: string;
+}

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

@@ -0,0 +1,8 @@
+export interface AgentDataReport {
+    darkTheme?: boolean;
+    defaultTimePeriod?: string;
+    layout?: object;
+    name?: string;
+    publicId: string;
+    version?: string;
+}

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

@@ -0,0 +1,16 @@
+import type { DataProtocolAppliedUnion } from './data-protocol-applied';
+import type { ResLink } from './res-link';
+export interface AgentDataSource {
+    agent?: ResLink;
+    device?: ResLink;
+    disabled?: boolean;
+    mqttBrokerClient?: ResLink | null;
+    mqttTopic?: string | null;
+    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-pull.d.ts

@@ -0,0 +1,4 @@
+export interface AgentPull {
+    device: string;
+    pullCode: string;
+}

package/dist/types/ixapi/resources/agent-queue-report.d.ts

@@ -0,0 +1,16 @@
+import type { ResLink } from './res-link';
+export interface AgentQueueReport extends QueueReport {
+    agent: ResLink;
+    message?: string;
+    report: ResLink;
+    sendTo: string[];
+}
+export interface QueueDraftReport extends QueueReport {
+    agent: ResLink;
+}
+interface QueueReport {
+    end: string;
+    start: string;
+    timeZone: string;
+}
+export {};

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

@@ -0,0 +1,11 @@
+import type { ResLink } from './res-link';
+export interface AgentRouterLanWanAccessRule {
+    agent?: ResLink;
+    description?: string | null;
+    destinationPort?: number | null;
+    protocol?: AgentRouterTransportProtocol;
+    publicId: string;
+    sourceIpAddress?: string | null;
+    sourceMacAddress?: string | null;
+}
+export type AgentRouterTransportProtocol = 'all' | 'tcp' | 'udp' | 'icmp' | 'ah' | 'ax.25' | 'dccp' | 'ddp' | 'egp' | 'eigrp' | 'encap' | 'esp' | 'etherip' | 'fc' | 'ggp' | 'gre' | 'hmp' | 'idpr-cmtp' | 'idrp' | 'igmp' | 'igp' | 'ipcomp' | 'ipencap' | 'ipip' | 'ipv6' | 'ipv6-frag' | 'ipv6-icmp' | 'ipv6-nonxt' | 'ipv6-opts' | 'ipv6-route' | 'isis' | 'iso-tp4' | 'l2tp' | 'ospf' | 'pim' | 'pup' | 'rdp' | 'rspf' | 'rsvp' | 'sctp' | 'skip' | 'st' | 'vmtp' | 'vrrp' | 'xns-idp' | 'xtp';

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,26 @@
+import type { ResLink } from './res-link';
+export interface AgentServer {
+    agent?: ResLink;
+    audience?: ResLink | null;
+    connectionQuality?: 'high' | 'normal' | 'low' | null;
+    custom?: {};
+    device?: ResLink;
+    httpAuthenticationType?: 'ntlm' | 'basic' | 'digest' | null;
+    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;
+    /** default: true */
+    visibleInMobileApp?: boolean;
+    vncEncoding?: string | null;
+    vncRightClickOnTouchHold?: boolean;
+}

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-file.d.ts

@@ -0,0 +1,10 @@
+export interface AgentTypeFile {
+    code?: string;
+    description?: string;
+    latest?: boolean;
+    name?: string;
+    notes?: string;
+    publicId: string;
+    size?: number;
+    type?: 'firmware';
+}

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;
+}