@progress/kendo-angular-grid 19.3.0-develop.20 → 19.3.0-develop.22

package/rendering/toolbar/tools/ai-assistant/ai-tool.directive.d.ts

@@ -0,0 +1,119 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { NgZone, AfterViewInit, OnInit, OnDestroy, ChangeDetectorRef, EventEmitter } from '@angular/core';
+import { RefreshService, ToolBarButtonComponent } from '@progress/kendo-angular-toolbar';
+import { SVGIcon } from '@progress/kendo-svg-icons';
+import { ContextService } from '../../../../common/provider.service';
+import { ToolbarToolBase } from '../../../../common/toolbar-tool-base.directive';
+import { WindowService } from '@progress/kendo-angular-dialog';
+import { HttpErrorResponse, HttpResponse } from '@angular/common/http';
+import { GridToolbarAIOpenEvent, GridToolbarAIPromptSettings, GridToolbarAIWindowSettings, GridToolbarAIRequestData, GridToolbarAIRequestResponse, GridToolbarAIRequestOptions } from './utils';
+import * as i0 from "@angular/core";
+/**
+ * Represents an AI Assistant tool of the Grid.
+ * Use this directive on any `kendo-toolbar-button` inside a ToolbarComponent in the Grid.
+ *
+ * @example
+ * ```html-no-run
+ * <kendo-grid>
+ *      <kendo-toolbar>
+ *         <kendo-toolbar-button kendoGridAIAssistantTool></kendo-toolbar-button>
+ *      </kendo-toolbar>
+ * </kendo-grid>
+ * ```
+ * @remarks
+ * Applied to: {@link ToolBarButtonComponent}.
+ */
+export declare class AIAssistantToolbarDirective extends ToolbarToolBase implements OnInit, AfterViewInit, OnDestroy {
+    private windowService;
+    host: ToolBarButtonComponent;
+    ctx: ContextService;
+    zone: NgZone;
+    private refresh;
+    /**
+     * The URL to which the AI Assistant tool sends the AI request.
+     * - When you set this property, the AI Assistant tool sends and handles an HTTP request to the provided `requestUrl`. You can handle the `promptRequest` event to modify the request options before the tool sends it.
+     * - When you do not set this property, the AI Assistant tool does not send an HTTP request. You should handle the `promptRequest` event to send and handle a custom HTTP request.
+     */
+    requestUrl?: string;
+    /**
+     * Configures the request options that the AI Assistant tool sends with the AI request.
+     *
+     * @default
+     * ```typescript
+     * {
+     *   headers: new HttpHeaders({ 'Content-Type': 'application/json' }),
+     *   role: 'user',
+     *   method: 'POST',
+     *   responseType: 'json',
+     *   withCredentials: false
+     * }
+     * ```
+     */
+    requestOptions?: GridToolbarAIRequestOptions;
+    /**
+     * Configures the settings for the AI Assistant Window.
+     */
+    aiWindowSettings: GridToolbarAIWindowSettings;
+    /**
+     * Configures the settings for the AI prompt component that the AI Assistant Window component uses.
+     */
+    aiPromptSettings: GridToolbarAIPromptSettings;
+    /**
+     * Emits an event before the AI Assistant tool sends the AI request.
+     *  - When you provide a `requestUrl`, you can handle the event to modify the request options.
+     *  - When you do not provide a `requestUrl`, you can handle the event to perform an entirely custom request.
+     */
+    promptRequest: EventEmitter<{
+        requestData: GridToolbarAIRequestData;
+        isRetry: boolean;
+    }>;
+    /**
+     * Emits an event when the user clicks the cancel button.
+     */
+    cancelRequest: EventEmitter<undefined>;
+    /**
+     * Emits an event when the AI Assistant tool completes the AI request successfully.
+     * The event contains the response from the AI service.
+     */
+    responseSuccess: EventEmitter<HttpResponse<GridToolbarAIRequestResponse>>;
+    /**
+     * Emits an event when the AI Assistant tool completes the AI request with an error.
+     * The event contains the response from the AI service.
+     */
+    responseError: EventEmitter<HttpErrorResponse>;
+    /**
+     * Emits an event when the AI Assistant tool closes.
+     */
+    close: EventEmitter<undefined>;
+    /**
+     * Emits an event when the AI Assistant tool opens.
+     * The event contains the window instance and the AI prompt instance.
+     */
+    open: EventEmitter<GridToolbarAIOpenEvent>;
+    tableWizardIcon: SVGIcon;
+    private windowRef;
+    private subs;
+    private actionSheetCloseSub;
+    private emitOpenClose;
+    private defaultAiPromptSettings;
+    constructor(windowService: WindowService, host: ToolBarButtonComponent, ctx: ContextService, zone: NgZone, refresh: RefreshService, cdr: ChangeDetectorRef);
+    ngOnInit(): void;
+    ngAfterViewInit(): void;
+    ngOnDestroy(): void;
+    /**
+     * @hidden
+     */
+    onClick(): void;
+    /**
+     * Toggles the AI Assistant window.
+     */
+    toggleWindow(): void;
+    private openWindow;
+    private closeWindow;
+    private get buttonElement();
+    static ɵfac: i0.ɵɵFactoryDeclaration<AIAssistantToolbarDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<AIAssistantToolbarDirective, "[kendoGridAIAssistantTool]", never, { "requestUrl": { "alias": "requestUrl"; "required": false; }; "requestOptions": { "alias": "requestOptions"; "required": false; }; "aiWindowSettings": { "alias": "aiWindowSettings"; "required": false; }; "aiPromptSettings": { "alias": "aiPromptSettings"; "required": false; }; }, { "promptRequest": "promptRequest"; "cancelRequest": "cancelRequest"; "responseSuccess": "responseSuccess"; "responseError": "responseError"; "close": "close"; "open": "open"; }, never, never, true, never>;
+}

package/rendering/toolbar/tools/ai-assistant/utils.d.ts

@@ -0,0 +1,110 @@
+/**-----------------------------------------------------------------------------------------
+* Copyright © 2025 Progress Software Corporation. All rights reserved.
+* Licensed under commercial license. See LICENSE.md in the project root for more information
+*-------------------------------------------------------------------------------------------*/
+import { HttpHeaders } from "@angular/common/http";
+import { AIPromptComponent, AIPromptSettings } from "@progress/kendo-angular-conversational-ui";
+import { WindowComponent, WindowSettings } from "@progress/kendo-angular-dialog";
+import { CompositeFilterDescriptor, FilterDescriptor, GroupDescriptor, SortDescriptor } from "@progress/kendo-data-query";
+/**
+ * Interface representing all configuration options of the Ai Assistant Window.
+ */
+export interface GridToolbarAIWindowSettings extends Omit<WindowSettings, 'content'> {
+}
+/**
+ * Interface representing all configuration options of the Ai Assistant Prompt.
+ */
+export interface GridToolbarAIPromptSettings extends Omit<AIPromptSettings, 'promptCommands'> {
+}
+/**
+ * Represents the event data when the AI Assistant window is opened.
+ */
+export interface GridToolbarAIOpenEvent {
+    aiWindow: WindowComponent;
+    aiPrompt: AIPromptComponent;
+}
+/**
+ * Represents the data sent in the AI request from the Grid Toolbar AI Assistant.
+ */
+export interface GridToolbarAIRequestData {
+    columns: Array<{
+        field: string;
+        title: string;
+    }>;
+    promptMessage: string;
+    url?: string;
+    requestOptions: {
+        role?: string;
+        headers?: HttpHeaders;
+        method?: string;
+        withCredentials?: boolean;
+        body?: any;
+        responseType?: 'json' | 'arraybuffer' | 'blob' | 'text';
+        [key: string]: any;
+    };
+}
+/**
+ * Represents the response from the AI request in the Grid Toolbar AI Assistant.
+ */
+export interface GridToolbarAIRequestResponse {
+    messages: string[];
+    sort?: SortDescriptor[];
+    filter?: CompositeFilterDescriptor;
+    group?: GroupDescriptor[];
+    highlight?: {
+        cells: {
+            [key: string]: boolean;
+        };
+        filters: FilterDescriptor[];
+        logic: 'and' | 'or';
+    }[];
+}
+/**
+ * Configuration options for the HTTP request.
+ */
+export interface GridToolbarAIRequestOptions {
+    /**
+     * HTTP headers to include with the request.
+     */
+    headers?: HttpHeaders;
+    /**
+     * The role of the user making the request, e.g., 'user', 'assistant'.
+     * @default 'user'
+     */
+    role?: string;
+    /**
+     * HTTP method to use for the request.
+     * @default 'POST'
+     */
+    method?: string;
+    /**
+     * Whether to include credentials (cookies, authorization headers) with the request.
+     * @default false
+     */
+    withCredentials?: boolean;
+    /**
+     * The expected response type.
+     * @default 'json'
+     */
+    responseType?: 'json' | 'arraybuffer' | 'blob' | 'text';
+    /**
+     * The body of the request.
+     */
+    body?: any;
+    /**
+     * Additional custom options that will be spread into the request configuration.
+     */
+    [key: string]: any;
+}
+/**
+ * @hidden
+ */
+export declare const DEFAULT_AI_REQUEST_OPTIONS: GridToolbarAIRequestOptions;
+/**
+ * @hidden
+ */
+export declare const convertDateStringsInFilter: (filter: any, columns: any[]) => any;
+/**
+ * @hidden
+ */
+export declare const isDateField: (fieldName: string, columns: any[]) => boolean;

package/schematics/ngAdd/index.js

@@ -4,14 +4,14 @@ const schematics_1 = require("@angular-devkit/schematics");
 function default_1(options) {
     const finalOptions = Object.assign(Object.assign({}, options), { mainNgModule: 'GridModule', package: 'grid', peerDependencies: {
             // peer deps of the dropdowns
-            '@progress/kendo-angular-treeview': '19.3.0-develop.20',
-            '@progress/kendo-angular-navigation': '19.3.0-develop.20',
+            '@progress/kendo-angular-treeview': '19.3.0-develop.22',
+            '@progress/kendo-angular-navigation': '19.3.0-develop.22',
             // peer dependency of kendo-angular-inputs
-            '@progress/kendo-angular-dialog': '19.3.0-develop.20',
+            '@progress/kendo-angular-dialog': '19.3.0-develop.22',
             // peer dependency of kendo-angular-icons
             '@progress/kendo-svg-icons': '^4.0.0',
             // peer dependency of kendo-angular-layout
-            '@progress/kendo-angular-progressbar': '19.3.0-develop.20'
+            '@progress/kendo-angular-progressbar': '19.3.0-develop.22'
         } });
     return (0, schematics_1.externalSchematic)('@progress/kendo-angular-schematics', 'ng-add', finalOptions);
 }