@ixon-cdk/types 1.13.0-next.2 → 1.13.0

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

@@ -8,11 +8,13 @@ import type { ComponentContextAppData } from './app-data';
 import type { ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
 import type { AlertDialogOptions, ConfirmDialogOptions, ContentDialogOptions, FormDialogOptions, FormDialogResult } from './dialog';
 import type { ActionMenuOptions, ActionMenuResult } from './menu';
+import type { ToastOptions } from './toast';
 import type { Tooltip, TooltipOptions } from './tooltip';
 export type { ComponentContextAppData } from './app-data';
 export type { ActionBottomSheetAction, ActionBottomSheetOptions, ActionBottomSheetResult } from './bottom-sheet';
 export type { AlertDialogOptions, ConfirmDialogOptions, ContentDialogOptions, FormDialogOptions, FormDialogResult, } from './dialog';
 export type { ActionMenuAction, ActionMenuOptions, ActionMenuResult } from './menu';
+export type { ToastOptions } from './toast';
 export type { Tooltip, TooltipOptions } from './tooltip';
 export * from './input';
 /**
@@ -175,6 +177,41 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * @param options configures the form dialog
      */
     openFormDialog(options: FormDialogOptions): Promise<FormDialogResult | false | undefined>;
+    /**
+     * Opens a toast notification.
+     *
+     * @param options - Options to configure the toast.
+     * @returns A promise that resolves to `true` if the action was triggered, or `undefined` otherwise.
+     *
+     * @example
+     * // Default auto-close behavior (true)
+     * context.openToast({ message: 'Changes saved' });
+     *
+     * // Default auto-close behavior when actionButtonText is set (false)
+     * context.openToast({ message: 'Connection timed out', actionButtonText: 'Retry' });
+     *
+     * // Overrides default auto-close behavior, despite actionButtonText being set.
+     * context.openToast({ message: 'Email archived', actionButtonText: 'Undo', autoClose: true });
+     */
+    openToast(options: ToastOptions): Promise<true | undefined>;
+    /**
+     * Opens a toast notification with a simple message and additional options.
+     *
+     * @param message - The message to display in the toast.
+     * @param options - Additional options to configure the toast.
+     * @returns A promise that resolves to `true` if the action was triggered, or `undefined` otherwise.
+     *
+     * @example
+     * // Default auto-close behavior (true)
+     * context.openToast('Changes saved');
+     *
+     * // Default auto-close behavior when actionButtonText is set (false)
+     * context.openToast('Connection timed out', { actionButtonText: 'Retry' });
+     *
+     * // Overrides default auto-close behavior, despite actionButtonText being set.
+     * context.openToast('Email archived', { actionButtonText: 'Undo', autoClose: true });
+     */
+    openToast(message: string, options?: Omit<ToastOptions, 'message'>): Promise<true | undefined>;
     /**
      * Helps preventing Cross Site Scripting Security bugs (XSS) by sanitizing the passed HTML, removing any potentially unsafe content.
      *
@@ -223,9 +260,9 @@ export interface ComponentContext<ComponentContextInputs extends object = {
      * @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>;
+    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 {
     /**

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

@@ -0,0 +1,14 @@
+export interface ToastOptions {
+    /**
+     * Text for an optional action button. If provided, `autoClose` defaults to false.
+     */
+    actionButtonText?: string;
+    /**
+     * Whether the toast automatically closes. Defaults to true, unless `actionButtonText` is set.
+     */
+    autoClose?: boolean;
+    /**
+     * The message to display in the toast.
+     */
+    message: string;
+}

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

@@ -19,6 +19,7 @@ export interface AccessToken {
 export interface AccessTokenCreate {
     /** In seconds. */
     expiresIn: number;
+    scope?: AccessTokenScopesUnion | null;
     trustedDeviceName?: string | null;
 }
 export interface AccessTokenSsoCreate extends AccessTokenCreate {

package/dist/types/ixapi/resources/agent-access-request.d.ts

@@ -9,6 +9,8 @@ export interface AgentAccessRequest {
     end?: string;
     publicId: string;
     reason?: string;
+    /** I.e. "2019-01-01T12:00:00Z" */
+    reviewExpiresOn?: string | null;
     servers?: AgentServerReference[];
     /** I.e. "2019-01-01T12:00:00Z" */
     start?: string;
@@ -18,7 +20,6 @@ export interface AgentAccessRequest {
     user?: UserReference;
     vpn?: boolean;
 }
-/** @check AgentAccessRequestApproveResponse*/
 export type AgentAccessRequestApproveResponse = AgentAccessRequestResult;
 export type AgentAccessRequestRejectResponse = AgentAccessRequestResult;
 type AgentAccessRequestStatus = 'approved' | 'pending' | 'rejected';

package/dist/types/ixapi/resources/audience-agent-reference.d.ts

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface AudienceAgentReference {
+    assets?: ResLink[];
+    audiences?: ResLink[];
+    name?: string;
+    publicId: string;
+}

package/dist/types/ixapi/resources/audience-asset-reference.d.ts

@@ -0,0 +1,7 @@
+import type { ResLink } from './res-link';
+export interface AudienceAssetReference {
+    name?: string;
+    publicId: string;
+    audiences?: ResLink[];
+    root?: ResLink;
+}

package/dist/types/ixapi/resources/data-protocol-applied.d.ts

@@ -12,7 +12,7 @@ export interface DataProtocolAppliedCustom {
     publicId: 'custom';
 }
 export interface DataProtocolAppliedEthernetIp {
-    cpu: EthernetIpCpu | null;
+    cpu?: EthernetIpCpu | null;
     publicId: 'ethernet-ip';
     /** only used when cpu in [compactlogix|controllogix|flexlogix]. default is 0 */
     rack?: number | null;

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

@@ -6,6 +6,13 @@ export interface Data {
     start: string;
     timeZone: string;
 }
+export interface DataCreate {
+    end: string;
+    source: ResLink;
+    start: string;
+    tags: Tag[];
+    timeZone?: string;
+}
 export interface DataPoint {
     /** "2019-01-01T12:00:00Z" */
     time: string;
@@ -18,12 +25,14 @@ export interface DataQuery {
     decimals?: number;
     /** Default is false */
     extendedBoundary?: boolean;
-    factor?: number;
+    factor?: number | string;
     /** Default is 5000 */
     limit?: number;
     offset?: number;
     operator?: string;
-    postAggr: string;
+    order?: 'asc' | 'desc';
+    postAggr?: string;
+    postTransform?: 'difference' | null;
     ref: string;
     step?: number | 'day' | 'week';
 }

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

@@ -37,6 +37,8 @@ export * from './asset-app-config';
 export * from './asset-library-version';
 export * from './asset-membership';
 export * from './asset-type';
+export * from './audience-agent-reference';
+export * from './audience-asset-reference';
 export * from './audience';
 export * from './audit-log';
 export * from './auth-token';
@@ -107,6 +109,7 @@ export * from './trusted-device';
 export * from './user';
 export * from './user-membership';
 export * from './user-push-device';
+export * from './vpn-config';
 export * from './vpn-protocol';
 export * from './vpn-session';
 export * from './vpn-usage';

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

@@ -0,0 +1,7 @@
+import type { Agent } from './agent';
+import type { Company } from './company';
+export interface MyUserVpnConfig {
+    agent?: Agent;
+    company?: Company;
+    openvpnConfig?: string | null;
+}

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

@@ -11,6 +11,7 @@ interface ResultDataMap {
     Branding: ResourceData.Branding;
     CustomPropertyList: ResourceData.CustomProperty[];
     GroupList: ResourceData.Group[];
+    LicenceList: ResourceData.Licence[];
     MyCompany: ResourceData.MyCompany;
     MyUser: ResourceData.MyUser;
     PagePage: ResourceData.PagePage;

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

@@ -1,5 +1,5 @@
 /** @module ResourceDataQuery */
-export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
+export type ResourceDataQuerySelector = 'Agent' | 'Asset' | 'AssetAppConfig' | 'AssetAppConfigList' | 'Branding' | 'CustomPropertyList' | 'GroupList' | 'LicenceList' | 'MyCompany' | 'MyUser' | 'PagePage' | 'PageVersion' | 'UserList';
 export interface ResourceDataQuery<T = ResourceDataQuerySelector> {
     /**
      * String reference unique to the query call made by the client

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

@@ -147,6 +147,13 @@ interface GroupResourceData {
         publicId: string;
     } | null;
 }
+interface LicenceResourceData {
+    publicId: string;
+    type?: {
+        publicId: string;
+        usageType?: string;
+    };
+}
 interface MyCompanyResourceData {
     name?: string;
     permissions?: string[];
@@ -182,6 +189,7 @@ export declare namespace ResourceData {
     type Branding = BrandingResourceData;
     type CustomProperty = CustomPropertyResourceData;
     type Group = GroupResourceData;
+    type Licence = LicenceResourceData;
     type MyCompany = MyCompanyResourceData;
     type MyUser = MyUserResourceData;
     type PagePage = PagePageResourceData;

package/package.json

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