@jupyterlite/ai 0.6.2 → 0.8.0

package/lib/settings/panel.d.ts

@@ -1,24 +1,89 @@
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { ISettingConnector } from '@jupyterlab/settingregistry';
 import { IFormRenderer } from '@jupyterlab/ui-components';
 import type { FieldProps } from '@rjsf/utils';
 import { JSONSchema7 } from 'json-schema';
 import { ISecretsManager } from 'jupyter-secrets-manager';
 import React from 'react';
-import { IAIProviderRegistry, IDict } from '../tokens';
+import { IAIProviderRegistry, IDict, ModelRole } from '../tokens';
 export declare const aiSettingsRenderer: (options: {
     providerRegistry: IAIProviderRegistry;
     secretsToken?: symbol;
     rmRegistry?: IRenderMimeRegistry;
     secretsManager?: ISecretsManager;
-    settingConnector?: ISettingConnector;
 }) => IFormRenderer;
-export interface ISettingsFormStates {
-    schema: JSONSchema7;
-    instruction: HTMLElement | null;
+export interface IAiSettings {
+    /**
+     * Get the local storage settings for a specific role (chat or completer).
+     */
+    getLocalStorage(role: ModelRole): IDict<any>;
+    /**
+     * Set the local storage item for a specific role (chat or completer).
+     * If the key is not provider (null) we assume the value should replace the whole
+     * local storage for this role.
+     */
+    setLocalStorageItem(role: ModelRole, key: string | null, value: any): void;
+    /**
+     * Get the settings from the registry (jupyterlab settings system) for a given role.
+     */
+    getSettingsFromRegistry(role: ModelRole): IDict<any>;
+    /**
+     * Save the settings to the setting registry.
+     */
+    saveSettingsToRegistry(role: ModelRole, settings: IDict<any>): void;
 }
-export declare class AiSettings extends React.Component<FieldProps, ISettingsFormStates> {
+export declare class AiSettings extends React.Component<FieldProps, AiSettings.states> implements IAiSettings {
     constructor(props: FieldProps);
+    private _settingsChanged;
+    /**
+     * Get the local storage settings for a specific role (chat or completer).
+     */
+    getLocalStorage: (role: ModelRole) => IDict<any>;
+    /**
+     * Set the local storage item for a specific role (chat or completer).
+     * If the key is not provider (null) we assume the value should replace the whole
+     * local storage for this role.
+     */
+    setLocalStorageItem: (role: ModelRole, key: string | null, value: any) => void;
+    /**
+     * Get the settings from the registry (jupyterlab settings system) for a given role.
+     */
+    getSettingsFromRegistry: (role: ModelRole) => IDict<any>;
+    /**
+     * Save the settings to the setting registry.
+     */
+    saveSettingsToRegistry: (role: ModelRole, settings: IDict<any>) => void;
+    render(): JSX.Element;
+    private _settings;
+}
+/**
+ * The AI settings component namespace.
+ */
+declare namespace AiSettings {
+    /**
+     * The AI settings component states.
+     */
+    type states = {
+        /**
+         * Whether there is only one provider for chat and completion.
+         */
+        uniqueProvider: boolean;
+    };
+    /**
+     * The provider names object.
+     */
+    type providers = {
+        [key in ModelRole]: string;
+    };
+    /**
+     * The provider schemas object.
+     */
+    type schemas = {
+        [key in ModelRole]: JSONSchema7;
+    };
+}
+export declare class AiProviderSettings extends React.Component<AiProviderSettings.props, AiProviderSettings.states> {
+    constructor(props: AiProviderSettings.props);
+    componentDidMount(): void;
     componentDidUpdate(): Promise<void>;
     componentWillUnmount(): void;
     /**
@@ -30,13 +95,25 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
      */
     saveCurrentProvider(): void;
     /**
-     * Get settings from local storage for a given provider.
+     * Get settings from local storage for the current provider provider.
      */
-    getSettings(): IDict<any>;
+    getSettingsFromLocalStorage(): IDict<any>;
     /**
      * Save settings in local storage for a given provider.
      */
-    saveSettings(value: IDict<any>): void;
+    saveSettingsToLocalStorage(): void;
+    /**
+     * Save the settings to the setting registry.
+     */
+    saveSettingsToRegistry(): void;
+    /**
+     * Triggered when the settings has changed.
+     */
+    private _settingsChanged;
+    /**
+     * Triggered when the secret fields visibility has changed.
+     */
+    private _fieldVisibilityChanged;
     /**
      * Update the settings whether the secrets manager is used or not.
      *
@@ -57,7 +134,12 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
      */
     private _renderInstruction;
     /**
-     * Triggered when the provider hes changed, to update the schema and values.
+     * Check for compatibility of the provider with the current environment.
+     * If the provider is not compatible, display an error message.
+     */
+    private _checkProviderCompatibility;
+    /**
+     * Triggered when the provider has changed, to update the schema and values.
      * Update the Jupyterlab settings accordingly.
      */
     private _onProviderChanged;
@@ -66,24 +148,79 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
      * with the secret manager.
      */
     private _onPasswordUpdated;
+    /**
+     * Update the current settings with the new values from the form.
+     *
+     * @param data - The form data to update.
+     * @returns - Boolean whether the form is not the default one.
+     */
+    private _updatedFormData;
     /**
      * Triggered when the form value has changed, to update the current settings and save
      * it in local storage.
      * Update the Jupyterlab settings accordingly.
      */
-    private _onFormChange;
+    private _onFormChanged;
+    /**
+     * Handler for the "Restore to defaults" button - clears all
+     * modified settings then calls `setFormData` to restore the
+     * values.
+     */
+    private _reset;
     render(): JSX.Element;
+    private _role;
     private _providerRegistry;
     private _provider;
     private _providerSchema;
     private _useSecretsManager;
-    private _hideSecretFields;
     private _rmRegistry;
     private _secretsManager;
-    private _settingConnector;
     private _currentSettings;
     private _uiSchema;
     private _settings;
     private _formRef;
     private _secretFields;
+    private _defaultFormData;
+}
+/**
+ * The AI provider settings component namespace.
+ */
+export declare namespace AiProviderSettings {
+    /**
+     * The AI provider settings component props.
+     */
+    type props = FieldProps & {
+        /**
+         * Why this model is used for (chat or completion).
+         */
+        role: ModelRole;
+        /**
+         * The parent component which should handle:
+         * - the get/set functions for local storage
+         * - save settings using jupyter settings system
+         */
+        aiSettings: IAiSettings;
+    };
+    /**
+     * The AI provider settings component states.
+     */
+    type states = {
+        /**
+         * The schema of the settings.
+         */
+        schema: JSONSchema7;
+        /**
+         * The instructions for this provider.
+         */
+        instruction: HTMLElement | null;
+        /**
+         * An error if the model in not compatible with the current environment.
+         */
+        compatibilityError: string | null;
+        /**
+         * Whether the settings are modified from default or not.
+         */
+        isModified?: boolean;
+    };
 }
+export {};