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

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

@@ -0,0 +1,23 @@
+import type { ResLink } from './res-link';
+import type { Sector } from './sector';
+export interface PolicyLanguage {
+    body?: string;
+    languageCode?: string;
+    publicId: string;
+    policy?: ResLink;
+}
+export interface PolicyBase {
+    company?: ResLink | null;
+    createdOn?: string;
+    downloadUrl?: string;
+    latest?: boolean;
+    languages?: PolicyLanguage[];
+    publicId: string;
+    publishedOn?: string | null;
+    sector?: Sector;
+    version?: string;
+}
+export interface TermsOfUsePolicy extends PolicyBase {
+}
+export interface PrivacyStatement extends PolicyBase {
+}

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

@@ -0,0 +1,6 @@
+export interface ResLink {
+    publicId: string;
+    reference?: {
+        name: string;
+    };
+}

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

@@ -0,0 +1,6 @@
+import type { PlatformServer } from './platform-server';
+export interface RscServer extends PlatformServer {
+    entryPoint?: string;
+    supportedLayers?: NetworkLayer[];
+}
+export type NetworkLayer = 'tap' | 'tun';

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

@@ -0,0 +1,31 @@
+import type { Branding } from './branding';
+import type { PrivacyStatement } from './policy';
+export interface Sector {
+    allowCustomPrivacyStatement?: boolean;
+    allowCustomTermsOfUse?: boolean;
+    branding?: Branding | null;
+    corporateWebsite?: string | null;
+    custom?: {
+        glbRouterConfigName?: string;
+        glbShowCustomComponents?: boolean;
+        /** @deprecated */
+        glbSlaDownloadUrl?: string;
+        glbSupportedPlatforms?: string;
+        glbVpnClientReleaseNotesUrl?: string;
+    };
+    defaultCountry?: string;
+    emailFromAddress?: string;
+    feedbackTo?: string;
+    latestPrivacyStatement?: PrivacyStatement;
+    name?: string;
+    poweredBy?: SectorPoweredBy;
+    premiumBrandingDomain?: string;
+    publicId: string;
+    supportEmailAddress?: string | null;
+}
+export interface SectorPoweredBy {
+    hide?: boolean;
+    logo?: string;
+    name?: string;
+    url?: string;
+}

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

@@ -0,0 +1,11 @@
+import type { ResLink } from './res-link';
+export interface UserMembership {
+    expiresOn?: string | null;
+    group?: ResLink;
+    /** null for users */
+    invite?: ResLink | null;
+    publicId: string;
+    role?: ResLink | null;
+    /** null for invites */
+    user?: ResLink | null;
+}

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

@@ -0,0 +1,55 @@
+import type { EmailAddressChange } from './email-address-change';
+import type { Invite } from './invite';
+import type { OtpAuth } from './otp-auth';
+import type { TermsOfUsePolicy } from './policy';
+import type { UserMembership } from './user-membership';
+export interface User {
+    /** @changeNotification taint */
+    emailAddress?: string;
+    /** For example 2019-01-01T12:00:00Z */
+    lastSeenOn?: string;
+    memberships?: UserMembership[];
+    /** @changeNotification taint */
+    name?: string;
+    /** Whether the user has two-factor authentication activated for their account. */
+    otpauthRequired?: boolean;
+    publicId: string;
+    support?: boolean;
+}
+export interface MyUser {
+    custom?: {
+        /** JSON Object with user colomns per company, For example: { "1111-2222-3333-4444-5555": ["status", "name", "lastOnline"]} */
+        glbFltDeviceTableCols?: string;
+        /** JSON Object with user colomns per company, For example: { "1111-2222-3333-4444-5555": ["status", "name", "lastOnline"]} */
+        glbPrtDeviceTableCols?: string;
+        /** JSON Object with view settings per company,
+         * For example:
+         * {
+         *    "1111-2222-3333-4444-5555": {
+         *      "type": { "gtSm": "list", "ltSm": "card"}, cardSortBy: { "gtSm": "name;asc", "ltSm": "groupType.AAAAAAAAAAAA;desc" }, deviceMapState: { "gtSm": "closed", "ltSm": "open" }, deviceMapHeight: { "gtSm": "100" }
+         *    }
+         * }
+         */
+        glbPrtDeviceViewSettings?: string;
+        /** JSON Object with starred agents per company, For example: { "1111-2222-3333-4444-5555": ["ixagent00001", "ixagent00003"]} */
+        glbStarred?: string;
+    };
+    emailAddress?: string;
+    emailAddressChanges?: EmailAddressChange[];
+    invites?: Invite[];
+    language?: string;
+    /** For example 2019-01-01T12:00:00Z */
+    lastSeenOn?: string;
+    localisation?: string | null;
+    name?: string;
+    otpAuth?: OtpAuth | null;
+    publicId: string;
+    /** For example 2019-01-01T12:00:00Z */
+    registeredOn?: string;
+    support?: boolean;
+    termsOfUsePolicy?: TermsOfUsePolicy | null;
+    /** For example 2019-01-01T12:00:00Z */
+    termsOfUsePolicyAcceptedOn?: string | null;
+    timeZone?: string | null;
+    unreadMessagesCount?: number;
+}

package/dist/types/ixapi/resources/vpn-protocol.d.ts

@@ -0,0 +1 @@
+export type VpnProtocol = 'tcp' | 'udp';

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,10 @@
+/** @module LoggingDataQueryRef */
+import type { AgentDataTag } from '../ixapi/resources/agent-data-tag';
+import type { AgentDataVariable } from '../ixapi/resources/agent-data-variable';
+import type { LoggingDataQuery } from './logging-data-query';
+export interface LoggingDataQueryRef {
+    query: LoggingDataQuery;
+    variable?: AgentDataVariable;
+    tag?: AgentDataTag;
+    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,38 @@
+/** @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.
+     *
+     * If ommited, an empty object is returned
+     */
+    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,67 @@
+import type { Agent, AgentUserAgent } from '../ixapi/resources/agent';
+import type { AgentDataSource } from '../ixapi/resources/agent-data-source';
+import type { AgentServer } from '../ixapi/resources/agent-server';
+import type { AgentType } from '../ixapi/resources/agent-type';
+import type { Asset } from '../ixapi/resources/asset';
+import type { AssetType } from '../ixapi/resources/asset-type';
+import type { Branding, BrandingTheme } from '../ixapi/resources/branding';
+import type { CustomProperty } from '../ixapi/resources/custom-property';
+import type { Location } from '../ixapi/resources/location';
+import type { Group } from '../ixapi/resources/group';
+import type { GroupType } from '../ixapi/resources/group-type';
+import type { PagePage } from '../ixapi/resources/page-page';
+import type { PageVersion } from '../ixapi/resources/page-version';
+import type { MyUser, User } from '../ixapi/resources/user';
+interface AgentResourceData extends Pick<Agent, 'custom' | 'description' | 'loggingMdrServer' | 'loggingMqttChangedOn' | 'macAddress' | 'mdrServer' | 'mqttChangedOn' | 'name' | 'publicId' | 'rateLimiting' | 'serialNumber'> {
+    activeVpnSession?: {
+        rscServer?: {
+            name?: string;
+            publicId: string;
+        } | null;
+        vpnAddress?: string;
+    } | null;
+    connectedUsers?: Pick<User, 'name' | 'publicId'>[];
+    dataSources?: Pick<AgentDataSource, 'name' | 'publicId' | 'slug'>[];
+    lastSeenAgentUserAgent?: Pick<AgentUserAgent, 'firmwareVersion' | 'hardware' | 'hardwareVersion' | 'publicId'> | null;
+    location?: Pick<Location, 'name'> | null;
+    memberships?: {
+        group?: {
+            publicId: string;
+        };
+        publicId: string;
+    }[];
+    servers?: Pick<AgentServer, 'custom' | 'name' | 'publicId' | 'serviceGroup' | 'type'>[];
+    type?: Pick<AgentType, 'name' | 'publicId'>;
+}
+interface AssetResourceData extends Pick<Asset, 'custom' | 'description' | 'name' | 'publicId'> {
+    memberships?: {
+        group?: {
+            publicId: string;
+        };
+        publicId: string;
+    }[];
+    resourceVariant?: Pick<AssetType, 'publicId'>;
+}
+interface BrandingResourceData extends Pick<Branding, 'logo' | 'publicId'> {
+    theme?: Pick<BrandingTheme, 'logoHasBackgroundColor'> | null;
+}
+type CustomPropertyResourceData = Pick<CustomProperty, 'flags' | 'name' | 'publicId' | 'resourceType' | 'resourceVariant' | 'scopeType' | 'slug'>;
+interface GroupResourceData extends Pick<Group, 'name' | 'publicId'> {
+    type?: Pick<GroupType, 'name' | 'order' | 'publicId'> | null;
+}
+type MyUserResourceData = Pick<MyUser, 'custom' | 'name' | 'publicId' | 'unreadMessagesCount'>;
+type PagePageResourceData = Pick<PagePage, 'order' | 'publicId'>;
+interface PageVersionResourceData extends Pick<PageVersion, 'publicId' | 'title'> {
+    pagePages?: Pick<PagePage, 'order' | 'publicId'>[];
+}
+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

@@ -1,6 +1,6 @@
 {
   "name": "@ixon-cdk/types",
-  "version": "1.2.0-next.2",
+  "version": "1.2.0-next.3",
   "description": "",
   "main": "./dist/component-devkit/src/types/src/index.d.ts",
   "author": "",