@ixon-cdk/types 1.4.0 → 1.5.0-next.1

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

@@ -1,6 +1,7 @@
 export * from '../../../../types/component-context';
 export * from '../../../../types/backend-component';
 export * from '../../../../types/component-context';
+export * from '../../../../types/component-input';
 export * from '../../../../types/ixapi';
 export * from '../../../../types/ixapi/resources';
 export * from '../../../../types/logging-data';

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

@@ -0,0 +1,72 @@
+type ComponentInputType = 'AggregatedMetric' | 'Checkbox' | 'Color' | 'Date' | 'File' | 'Group' | 'Icon' | 'Image' | 'List' | 'LiveMetric' | 'MaterialIcon' | 'Number' | 'RawMetric' | 'Selection' | 'String' | 'Text';
+export interface ComponentInputSummary {
+    colorField?: string;
+    label: string;
+}
+export interface ComponentInput {
+    /**
+     * The types of tags or variables that are allowed for this metric. All types are allowed if empty ([]), null or not specified.
+     *
+     * Only applicable to types `RawMetric`, `AggregatedMetric` and `LiveMetric`.
+     */
+    allowedTypes?: ('bool' | 'int' | 'float' | 'str')[];
+    /**
+     * Only applicable to type `Group`.
+     */
+    children?: ComponentInput[];
+    defaultValue?: any;
+    description?: string;
+    /**
+     * @default false
+     */
+    disabled?: boolean;
+    hint?: string;
+    /**
+     * Specifies the type for every list-item.
+     *
+     * Only applicable to type `List`.
+     */
+    itemType?: ComponentInput;
+    key: string;
+    label?: string;
+    /**
+     * Only applicable to type `Number`.
+     */
+    max?: number;
+    /**
+     * Only applicable to type `Number`.
+     */
+    min?: number;
+    /**
+     * Only applicable to type `Selection`.
+     */
+    options?: {
+        label: string;
+        shortLabel?: string;
+        value: any;
+    }[];
+    placeholder?: string;
+    /**
+     * @default false
+     */
+    required?: boolean;
+    /**
+     * Only applicable to type `File`.
+     */
+    size?: {
+        max: number;
+    };
+    /**
+     * Only applicable to type `Number`.
+     */
+    step?: number;
+    summary?: ComponentInputSummary;
+    /**
+     * Only applicable to types `String` and `Text`.
+     *
+     * @default true
+     */
+    translate?: boolean;
+    type: ComponentInputType;
+}
+export {};

package/dist/types/ixapi/resources/agent-licence-bundle.d.ts

@@ -0,0 +1,6 @@
+import type { ResLink } from './res-link';
+export interface AgentLicenceBundleActivate {
+    publicId: string;
+    couponCode?: string;
+    bundle?: ResLink | null;
+}

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

@@ -20,6 +20,8 @@ export interface AgentServer {
     useSsl?: boolean;
     /** default: true */
     visibleInMobileApp?: boolean;
+    /** default: true */
+    visibleOnWeb?: boolean;
     vncEncoding?: string | null;
     vncRightClickOnTouchHold?: boolean;
 }
@@ -39,6 +41,7 @@ export interface AgentServerTemplate {
     username?: string | null;
     useSsl?: boolean;
     visibleInMobileApp?: boolean;
+    visibleOnWeb?: boolean;
     vncEncoding?: string | null;
     vncRightClickOnTouchHold?: boolean;
 }

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

@@ -86,6 +86,8 @@ export interface AgentLike {
     vpnProtocol?: VpnProtocol;
     /** default: false */
     vpnVisibleInMobileApp?: boolean;
+    /** default: true */
+    vpnVisibleOnWeb?: boolean;
 }
 export interface AgentLocalIp {
     reportedOn?: string;

package/dist/types/ixapi/resources/audit-log.d.ts

@@ -1,3 +1,4 @@
+import type { GeoLocation } from './location';
 export interface AuditLog {
     action: AuditLogAction;
     actor: AuditLogActor;
@@ -16,6 +17,7 @@ export interface AuditLog {
 export type AuditLogAction = 'CREATE' | 'UPDATE' | 'DELETE' | 'TRIGGER';
 interface AuditLogRequest {
     fromName: string | null;
+    geoLocation: GeoLocation | null;
     ipAddress: string;
 }
 interface AuditLogActor {

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

@@ -1,3 +1,4 @@
+import type { PageComponentTemplate } from './page-component-template';
 export interface Branding {
     appleAppStoreLink?: string | null;
     /** @deprecated */
@@ -10,6 +11,7 @@ export interface Branding {
     favicon?: string | null;
     fqdn?: string | null;
     googlePlayStoreLink?: string | null;
+    landingPageComponentTemplate?: PageComponentTemplate | null;
     logo?: string | null;
     name?: string | null;
     publicId: string;

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

@@ -44,13 +44,4 @@ export interface MyCompany extends Company {
     /** @deprecated */
     vpnUsageLicence?: Licence | null;
 }
-export interface LegacyCompany {
-    branding?: {
-        fqdn: null | string;
-    } | null;
-    name?: string;
-    parentCompany?: LegacyCompany | null;
-    publicId: string;
-    starred?: boolean;
-}
 export type CompanyReference = Pick<Company, 'publicId' | 'name'>;

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

@@ -12,6 +12,7 @@ export * from './agent-data-source';
 export * from './agent-data-tag';
 export * from './agent-data-variable';
 export * from './agent-device';
+export * from './agent-licence-bundle';
 export * from './agent-mdr-server';
 export * from './agent-membership';
 export * from './agent-network-value';
@@ -44,7 +45,6 @@ export * from './backend-component-template-share';
 export * from './backend-component-template-version';
 export * from './branding';
 export * from './company';
-export * from './component-input';
 export * from './custom-property';
 export * from './data';
 export * from './data-protocol';

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

@@ -1,5 +1,5 @@
 export type LicenceTypeScope = 'agent' | 'company';
-export type LicenceUsageType = 'advanced-user-management' | 'agent-registration-profile' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'ixagent' | 'live-data' | 'logging' | 'main-pages' | 'm2m-cloud-cluster' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'remote-access' | 'reporting' | 'sla' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
+export type LicenceUsageType = 'advanced-user-management' | 'agent-registration-profile' | 'alarming' | 'api-integrations' | 'app-engine-level-1' | 'app-engine-level-2' | 'asset-management' | 'card-view' | 'connection-monitoring' | 'custom-branding' | 'custom-domain' | 'custom-fields' | 'custom-legal' | 'custom-legal-legacy' | 'custom-sso' | 'ixagent' | 'landing-page' | 'live-data' | 'logging' | 'main-pages' | 'm2m-cloud-cluster' | 'mobile-app' | 'mqtt-device' | 'object-storage' | 'premium-branding' | 'remote-access' | 'reporting' | 'sla' | 'temporary-access' | 'vpn-access-rule' | 'vpn-usage';
 export interface LicenceType {
     companyLimit?: number | null;
     publicId: string;

package/dist/types/ixapi/resources/menu-item.d.ts

@@ -4,5 +4,6 @@ export interface MenuItem {
     audience?: Audience | null;
     order?: number;
     page?: Page;
+    pinned?: boolean;
     publicId: string;
 }

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

@@ -1,35 +1,35 @@
 export interface Message {
-    company?: string;
-    createdOn?: string;
-    code?: string;
-    longContent?: MessageLongContent;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    createdOn: string;
+    longContent: MessageLongContent;
     publicId: string;
-    read?: boolean;
-    shortContent?: MessageShortContent;
-    systemLabel?: MessageSystemLabel;
-    systemResult?: MessageSystemResult[];
-    userLabels?: any[];
+    read: boolean;
+    shortContent: MessageShortContent;
+    systemLabel: MessageSystemLabel | null;
+    systemResult: MessageSystemResult[];
 }
 export interface MessageShortContent {
-    code: string;
-    /** @deprecated */
-    message?: string;
-    toTranslate?: boolean;
-    [key: string]: any;
+    agentName?: string | null;
+    alarmName?: string | null;
+    code: string | null;
+    companyName?: string | null;
+    name?: string | null;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    occurredOn?: string;
+    toTranslate: boolean;
 }
 export interface MessageLongContent {
-    code: string;
+    code: string | null;
     extraInformation: MessageExtraInformation[];
-    /** @deprecated */
-    message?: string;
-    toTranslate?: boolean;
-    [key: string]: any;
+    instructions?: string;
+    name?: string | null;
+    toTranslate: boolean;
 }
 export interface MessageExtraInformation {
-    key: string;
-    type: 'string' | 'date';
-    toTranslate?: boolean;
-    value: string;
+    key: string | null;
+    toTranslate: boolean;
+    type: 'bool' | 'date' | 'float' | 'int' | 'string' | null;
+    value: boolean | number | string;
 }
-export type MessageSystemLabel = 'alarm-low' | 'alarm-medium' | 'alarm-high' | 'router-pulled';
-export type MessageSystemResult = 'forward-to-mail' | 'send-push-notification' | 'send-webhook-trigger';
+export type MessageSystemLabel = 'alarm-low' | 'alarm-medium' | 'alarm-high' | 'anti-theft-notification' | 'router-pulled';
+export type MessageSystemResult = 'forward-to-mail' | 'mark-as-read' | 'send-push-notification' | 'send-webhook-trigger';

package/dist/types/ixapi/resources/page-component-template.d.ts

@@ -31,4 +31,4 @@ export interface PageComponentTemplate {
     /** @deprecated */
     version?: string | null;
 }
-export type PageComponentTemplateIntent = 'asset-configuration';
+export type PageComponentTemplateIntent = 'asset-configuration' | 'landing-page';

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

@@ -65,12 +65,14 @@ interface AgentResourceData {
         serviceGroup?: string | null;
         type?: 'http' | 'rdp' | 'vnc' | 'websocket';
         visibleInMobileApp?: boolean;
+        visibleOnWeb?: boolean;
     }[];
     type?: {
         name?: string;
         publicId: string;
     };
     vpnVisibleInMobileApp?: boolean;
+    vpnVisibleOnWeb?: boolean;
 }
 interface AssetResourceData {
     custom?: Record<string, any>;
@@ -88,10 +90,10 @@ interface AssetResourceData {
         publicId: string;
     };
 }
-interface AssetAppConfigResourceData {
+interface AssetAppConfigResourceData<TValues = any, TStateValues = any> {
     publicId: string;
-    stateValues?: object | null;
-    values?: object | null;
+    stateValues?: TStateValues | null;
+    values?: TValues | null;
 }
 interface BrandingResourceData {
     logo?: string | null;
@@ -149,7 +151,7 @@ interface UserResourceData {
 export declare namespace ResourceData {
     type Agent = AgentResourceData;
     type Asset = AssetResourceData;
-    type AssetAppConfig = AssetAppConfigResourceData;
+    type AssetAppConfig<TValues = any, TStateValues = any> = AssetAppConfigResourceData<TValues, TStateValues>;
     type Branding = BrandingResourceData;
     type CustomProperty = CustomPropertyResourceData;
     type Group = GroupResourceData;

package/package.json

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

package/dist/types/ixapi/resources/component-input.d.ts

@@ -1,35 +0,0 @@
-type ComponentInputType = 'AggregatedMetric' | 'Checkbox' | 'Color' | 'Date' | 'File' | 'Group' | 'Image' | 'Icon' | 'MaterialIcon' | 'LiveMetric' | 'List' | 'Number' | 'RawMetric' | 'Selection' | 'String' | 'Text';
-export interface ComponentInputSummary {
-    label?: string;
-    colorField?: string;
-}
-export interface ComponentInput {
-    children?: ComponentInput[];
-    defaultValue?: any;
-    description?: string;
-    disabled?: boolean;
-    hint?: string;
-    itemType?: ComponentInput;
-    key: string;
-    label?: string;
-    max?: number;
-    maxLength?: number;
-    min?: number;
-    minLength?: number;
-    options?: {
-        label: string;
-        shortLabel?: string;
-        value: any;
-    }[];
-    pattern?: RegExp;
-    placeholder?: string;
-    required?: boolean;
-    step?: number;
-    summary?: ComponentInputSummary;
-    size?: {
-        max: number;
-    };
-    translate?: boolean;
-    type?: ComponentInputType;
-}
-export {};