@jupyterlite/ai 0.6.2 → 0.7.0

package/lib/index.js

@@ -3,14 +3,14 @@ import { IThemeManager } from '@jupyterlab/apputils';
 import { ICompletionProviderManager } from '@jupyterlab/completer';
 import { INotebookTracker } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { ISettingConnector, ISettingRegistry } from '@jupyterlab/settingregistry';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IFormRendererRegistry } from '@jupyterlab/ui-components';
 import { ISecretsManager, SecretsManager } from 'jupyter-secrets-manager';
-import { ChatHandler } from './chat-handler';
+import { ChatHandler, welcomeMessage } from './chat-handler';
 import { CompletionProvider } from './completion-provider';
 import { defaultProviderPlugins } from './default-providers';
 import { AIProviderRegistry } from './provider';
-import { aiSettingsRenderer, SettingConnector } from './settings';
+import { aiSettingsRenderer } from './settings';
 import { IAIProviderRegistry, PLUGIN_IDS } from './tokens';
 import { stopItem } from './components/stop-button';
 const chatCommandRegistryPlugin = {
@@ -54,7 +54,7 @@ const chatPlugin = {
             chatHandler.config = { sendWithShiftEnter, enableCodeToolbar };
             chatHandler.personaName = personaName;
         }
-        Promise.all([app.restored, settingsRegistry === null || settingsRegistry === void 0 ? void 0 : settingsRegistry.load(chatPlugin.id)])
+        Promise.all([app.restored, settingsRegistry?.load(chatPlugin.id)])
             .then(([, settings]) => {
             if (!settings) {
                 console.warn('The SettingsRegistry is not loaded for the chat extension');
@@ -70,8 +70,8 @@ const chatPlugin = {
         const inputToolbarRegistry = InputToolbarRegistry.defaultToolbarRegistry();
         const stopButton = stopItem(() => chatHandler.stopStreaming());
         inputToolbarRegistry.addItem('stop', stopButton);
-        chatHandler.writersChanged.connect((_, users) => {
-            if (users.filter(user => user.username === chatHandler.personaName).length) {
+        chatHandler.writersChanged.connect((_, writers) => {
+            if (writers.filter(writer => writer.user.username === chatHandler.personaName).length) {
                 inputToolbarRegistry.hide('send');
                 inputToolbarRegistry.show('stop');
             }
@@ -86,7 +86,8 @@ const chatPlugin = {
                 themeManager,
                 rmRegistry,
                 chatCommandRegistry,
-                inputToolbarRegistry
+                inputToolbarRegistry,
+                welcomeMessage: welcomeMessage(providerRegistry.providers)
             });
             chatWidget.title.caption = 'Jupyterlite AI Chat';
         }
@@ -113,9 +114,9 @@ const providerRegistryPlugin = SecretsManager.sign(PLUGIN_IDS.providerRegistry,
     id: PLUGIN_IDS.providerRegistry,
     autoStart: true,
     requires: [IFormRendererRegistry, ISettingRegistry],
-    optional: [IRenderMimeRegistry, ISecretsManager, ISettingConnector],
+    optional: [IRenderMimeRegistry, ISecretsManager],
     provides: IAIProviderRegistry,
-    activate: (app, editorRegistry, settingRegistry, rmRegistry, secretsManager, settingConnector) => {
+    activate: (app, editorRegistry, settingRegistry, rmRegistry, secretsManager) => {
         const providerRegistry = new AIProviderRegistry({
             token,
             secretsManager
@@ -124,16 +125,17 @@ const providerRegistryPlugin = SecretsManager.sign(PLUGIN_IDS.providerRegistry,
             providerRegistry,
             secretsToken: token,
             rmRegistry,
-            secretsManager,
-            settingConnector
+            secretsManager
         }));
         settingRegistry
             .load(providerRegistryPlugin.id)
             .then(settings => {
+            if (!secretsManager) {
+                delete settings.schema.properties?.['UseSecretsManager'];
+            }
             const updateProvider = () => {
-                var _a;
                 // Update the settings to the AI providers.
-                const providerSettings = ((_a = settings.get('AIprovider').composite) !== null && _a !== void 0 ? _a : {
+                const providerSettings = (settings.get('AIprovider').composite ?? {
                     provider: 'None'
                 });
                 providerRegistry.setProvider({
@@ -150,23 +152,11 @@ const providerRegistryPlugin = SecretsManager.sign(PLUGIN_IDS.providerRegistry,
         return providerRegistry;
     }
 }));
-/**
- * Provides the settings connector as a separate plugin to allow for alternative
- * implementations that may want to fetch settings from a different source or
- * endpoint.
- */
-const settingsConnector = {
-    id: PLUGIN_IDS.settingsConnector,
-    description: 'Provides a settings connector which does not save passwords.',
-    autoStart: true,
-    provides: ISettingConnector,
-    activate: (app) => new SettingConnector(app.serviceManager.settings)
-};
 export default [
     providerRegistryPlugin,
     chatCommandRegistryPlugin,
     chatPlugin,
     completerPlugin,
-    settingsConnector,
     ...defaultProviderPlugins
 ];
+export { IAIProviderRegistry } from './tokens';

package/lib/provider.d.ts

@@ -1,13 +1,12 @@
 import { BaseLanguageModel } from '@langchain/core/language_models/base';
-import { BaseChatModel } from '@langchain/core/language_models/chat_models';
 import { ISignal } from '@lumino/signaling';
 import { ReadonlyPartialJSONObject } from '@lumino/coreutils';
 import { JSONSchema7 } from 'json-schema';
 import { ISecretsManager } from 'jupyter-secrets-manager';
-import { IBaseCompleter } from './base-completer';
 import { IAIProvider, IAIProviderRegistry, ISetProviderOptions } from './tokens';
+import { AIChatModel, AICompleter } from './types/ai-model';
 export declare const chatSystemPrompt: (options: AIProviderRegistry.IPromptOptions) => string;
-export declare const COMPLETION_SYSTEM_PROMPT = "\nYou are an application built to provide helpful code completion suggestions.\nYou should only produce code. Keep comments to minimum, use the\nprogramming language comment syntax. Produce clean code.\nThe code is written in JupyterLab, a data analysis and code development\nenvironment which can execute code extended with additional syntax for\ninteractive features, such as magics.\nOnly give raw strings back, do not format the response using backticks.\nThe output should be a single string, and should correspond to what a human users\nwould write.\nDo not include the prompt in the output, only the string that should be appended to the current input.\n";
+export declare const COMPLETION_SYSTEM_PROMPT = "\nYou are an application built to provide helpful code completion suggestions.\nYou should only produce code. Keep comments to minimum, use the\nprogramming language comment syntax. Produce clean code.\nThe code is written in JupyterLab, a data analysis and code development\nenvironment which can execute code extended with additional syntax for\ninteractive features, such as magics.\nOnly give raw strings back, do not format the response using backticks.\nThe output should be a single string, and should only contain the code that will complete the\ngive code passed as input, no explanation whatsoever.\nDo not include the prompt in the output, only the string that should be appended to the current input.\nHere is the code to complete:\n";
 export declare class AIProviderRegistry implements IAIProviderRegistry {
     /**
      * The constructor of the provider registry.
@@ -26,13 +25,13 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
      */
     get currentName(): string;
     /**
-     * Get the current completer of the completion provider.
+     * Get the current AICompleter.
      */
-    get currentCompleter(): IBaseCompleter | null;
+    get currentCompleter(): AICompleter | null;
     /**
-     * Get the current llm chat model.
+     * Get the current AIChatModel.
      */
-    get currentChatModel(): BaseChatModel | null;
+    get currentChatModel(): AIChatModel | null;
     /**
      * Get the settings schema of a given provider.
      */
@@ -41,6 +40,10 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
      * Get the instructions of a given provider.
      */
     getInstructions(provider: string): string | undefined;
+    /**
+     * Get the compatibility check function of a given provider.
+     */
+    getCompatibilityCheck(provider: string): (() => Promise<string | null>) | undefined;
     /**
      * Format an error message from the current provider.
      */
@@ -50,7 +53,7 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
      */
     get chatError(): string;
     /**
-     * get the current completer error.
+     * Get the current completer error.
      */
     get completerError(): string;
     /**
@@ -65,14 +68,9 @@ export declare class AIProviderRegistry implements IAIProviderRegistry {
      */
     get providerChanged(): ISignal<IAIProviderRegistry, void>;
     private _secretsManager;
-    private _currentProvider;
-    private _completer;
-    private _chatModel;
-    private _name;
     private _providerChanged;
     private _chatError;
     private _completerError;
-    private _providers;
     private _deferredProvider;
 }
 export declare namespace AIProviderRegistry {

package/lib/provider.js

@@ -24,24 +24,16 @@ The code is written in JupyterLab, a data analysis and code development
 environment which can execute code extended with additional syntax for
 interactive features, such as magics.
 Only give raw strings back, do not format the response using backticks.
-The output should be a single string, and should correspond to what a human users
-would write.
+The output should be a single string, and should only contain the code that will complete the
+give code passed as input, no explanation whatsoever.
 Do not include the prompt in the output, only the string that should be appended to the current input.
+Here is the code to complete:
 `;
 export class AIProviderRegistry {
     /**
      * The constructor of the provider registry.
      */
     constructor(options) {
-        this._currentProvider = null;
-        this._completer = null;
-        this._chatModel = null;
-        this._name = 'None';
-        this._providerChanged = new Signal(this);
-        this._chatError = '';
-        this._completerError = '';
-        this._providers = new Map();
-        this._deferredProvider = null;
         this._secretsManager = options.secretsManager || null;
         Private.setToken(options.token);
     }
@@ -49,19 +41,18 @@ export class AIProviderRegistry {
      * Get the list of provider names.
      */
     get providers() {
-        return Array.from(this._providers.keys());
+        return Array.from(Private.providers.keys());
     }
     /**
      * Add a new provider.
      */
     add(provider) {
-        var _a;
-        if (this._providers.has(provider.name)) {
+        if (Private.providers.has(provider.name)) {
             throw new Error(`A AI provider named '${provider.name}' is already registered`);
         }
-        this._providers.set(provider.name, provider);
+        Private.providers.set(provider.name, provider);
         // Set the provider if the loading has been deferred.
-        if (provider.name === ((_a = this._deferredProvider) === null || _a === void 0 ? void 0 : _a.name)) {
+        if (provider.name === this._deferredProvider?.name) {
             this.setProvider(this._deferredProvider);
         }
     }
@@ -69,48 +60,70 @@ export class AIProviderRegistry {
      * Get the current provider name.
      */
     get currentName() {
-        return this._name;
+        return Private.getName();
     }
     /**
-     * Get the current completer of the completion provider.
+     * Get the current AICompleter.
      */
     get currentCompleter() {
-        if (this._name === 'None') {
+        if (Private.getName() === 'None') {
             return null;
         }
-        return this._completer;
+        const completer = Private.getCompleter();
+        if (completer === null) {
+            return null;
+        }
+        return {
+            fetch: (request, context) => completer.fetch(request, context)
+        };
     }
     /**
-     * Get the current llm chat model.
+     * Get the current AIChatModel.
      */
     get currentChatModel() {
-        if (this._name === 'None') {
+        if (Private.getName() === 'None') {
+            return null;
+        }
+        const currentProvider = Private.providers.get(Private.getName()) ?? null;
+        const chatModel = Private.getChatModel();
+        if (chatModel === null) {
             return null;
         }
-        return this._chatModel;
+        if (currentProvider?.exposeChatModel ?? false) {
+            // Expose the full chat model if expected.
+            return chatModel;
+        }
+        // Otherwise, we create a reduced AIChatModel interface.
+        return {
+            stream: (input, options) => chatModel.stream(input, options)
+        };
     }
     /**
      * Get the settings schema of a given provider.
      */
     getSettingsSchema(provider) {
-        var _a, _b;
-        return (((_b = (_a = this._providers.get(provider)) === null || _a === void 0 ? void 0 : _a.settingsSchema) === null || _b === void 0 ? void 0 : _b.properties) ||
+        return (Private.providers.get(provider)?.settingsSchema?.properties ||
             {});
     }
     /**
      * Get the instructions of a given provider.
      */
     getInstructions(provider) {
-        var _a;
-        return (_a = this._providers.get(provider)) === null || _a === void 0 ? void 0 : _a.instructions;
+        return Private.providers.get(provider)?.instructions;
+    }
+    /**
+     * Get the compatibility check function of a given provider.
+     */
+    getCompatibilityCheck(provider) {
+        return Private.providers.get(provider)?.compatibilityCheck;
     }
     /**
      * Format an error message from the current provider.
      */
     formatErrorMessage(error) {
-        var _a, _b;
-        if ((_a = this._currentProvider) === null || _a === void 0 ? void 0 : _a.errorMessage) {
-            return (_b = this._currentProvider) === null || _b === void 0 ? void 0 : _b.errorMessage(error);
+        const currentProvider = Private.providers.get(Private.getName()) ?? null;
+        if (currentProvider?.errorMessage) {
+            return currentProvider?.errorMessage(error);
         }
         if (error.message) {
             return error.message;
@@ -124,7 +137,7 @@ export class AIProviderRegistry {
         return this._chatError;
     }
     /**
-     * get the current completer error.
+     * Get the current completer error.
      */
     get completerError() {
         return this._completerError;
@@ -136,10 +149,9 @@ export class AIProviderRegistry {
      * @param options - An object with the name and the settings of the provider to use.
      */
     async setProvider(options) {
-        var _a, _b, _c, _d;
         const { name, settings } = options;
-        this._currentProvider = (_a = this._providers.get(name)) !== null && _a !== void 0 ? _a : null;
-        if (this._currentProvider === null) {
+        const currentProvider = Private.providers.get(name) ?? null;
+        if (currentProvider === null) {
             // The current provider may not be loaded when the settings are first loaded.
             // Let's defer the provider loading.
             this._deferredProvider = options;
@@ -147,12 +159,27 @@ export class AIProviderRegistry {
         else {
             this._deferredProvider = null;
         }
+        const compatibilityCheck = this.getCompatibilityCheck(name);
+        if (compatibilityCheck !== undefined) {
+            const error = await compatibilityCheck();
+            if (error !== null) {
+                this._chatError = error.trim();
+                this._completerError = error.trim();
+                Private.setName('None');
+                this._providerChanged.emit();
+                return;
+            }
+        }
+        if (name === 'None') {
+            this._chatError = '';
+            this._completerError = '';
+        }
         // Build a new settings object containing the secrets.
         const fullSettings = {};
         for (const key of Object.keys(settings)) {
             if (settings[key] === SECRETS_REPLACEMENT) {
                 const id = getSecretId(name, key);
-                const secrets = await ((_b = this._secretsManager) === null || _b === void 0 ? void 0 : _b.get(Private.getToken(), SECRETS_NAMESPACE, id));
+                const secrets = await this._secretsManager?.get(Private.getToken(), SECRETS_NAMESPACE, id);
                 if (secrets !== undefined) {
                     fullSettings[key] = secrets.value;
                 }
@@ -160,11 +187,11 @@ export class AIProviderRegistry {
             }
             fullSettings[key] = settings[key];
         }
-        if (((_c = this._currentProvider) === null || _c === void 0 ? void 0 : _c.completer) !== undefined) {
+        if (currentProvider?.completer !== undefined) {
             try {
-                this._completer = new this._currentProvider.completer({
+                Private.setCompleter(new currentProvider.completer({
                     settings: fullSettings
-                });
+                }));
                 this._completerError = '';
             }
             catch (e) {
@@ -172,24 +199,24 @@ export class AIProviderRegistry {
             }
         }
         else {
-            this._completer = null;
+            Private.setCompleter(null);
         }
-        if (((_d = this._currentProvider) === null || _d === void 0 ? void 0 : _d.chatModel) !== undefined) {
+        if (currentProvider?.chatModel !== undefined) {
             try {
-                this._chatModel = new this._currentProvider.chatModel({
+                Private.setChatModel(new currentProvider.chatModel({
                     ...fullSettings
-                });
+                }));
                 this._chatError = '';
             }
             catch (e) {
                 this._chatError = e.message;
-                this._chatModel = null;
+                Private.setChatModel(null);
             }
         }
         else {
-            this._chatModel = null;
+            Private.setChatModel(null);
         }
-        this._name = name;
+        Private.setName(name);
         this._providerChanged.emit();
     }
     /**
@@ -198,6 +225,11 @@ export class AIProviderRegistry {
     get providerChanged() {
         return this._providerChanged;
     }
+    _secretsManager;
+    _providerChanged = new Signal(this);
+    _chatError = '';
+    _completerError = '';
+    _deferredProvider = null;
 }
 (function (AIProviderRegistry) {
     /**
@@ -239,21 +271,57 @@ export class AIProviderRegistry {
 var Private;
 (function (Private) {
     /**
-     * The token to use with the secrets manager.
+     * The token to use with the secrets manager, setter and getter.
      */
     let secretsToken;
-    /**
-     * Set of the token.
-     */
     function setToken(value) {
         secretsToken = value;
     }
     Private.setToken = setToken;
-    /**
-     * get the token.
-     */
     function getToken() {
         return secretsToken;
     }
     Private.getToken = getToken;
+    /**
+     * The providers map, in private namespace to prevent updating the 'exposeChatModel'
+     * flag.
+     */
+    Private.providers = new Map();
+    /**
+     * The name of the current provider, setter and getter.
+     * It is in a private namespace to prevent updating it without updating the models.
+     */
+    let name = 'None';
+    function setName(value) {
+        name = value;
+    }
+    Private.setName = setName;
+    function getName() {
+        return name;
+    }
+    Private.getName = getName;
+    /**
+     * The chat model setter and getter.
+     */
+    let chatModel = null;
+    function setChatModel(model) {
+        chatModel = model;
+    }
+    Private.setChatModel = setChatModel;
+    function getChatModel() {
+        return chatModel;
+    }
+    Private.getChatModel = getChatModel;
+    /**
+     * The completer setter and getter.
+     */
+    let completer = null;
+    function setCompleter(model) {
+        completer = model;
+    }
+    Private.setCompleter = setCompleter;
+    function getCompleter() {
+        return completer;
+    }
+    Private.getCompleter = getCompleter;
 })(Private || (Private = {}));

package/lib/settings/index.d.ts

@@ -1,3 +1,2 @@
 export * from './panel';
-export * from './settings-connector';
 export * from './utils';

package/lib/settings/index.js

@@ -1,3 +1,2 @@
 export * from './panel';
-export * from './settings-connector';
 export * from './utils';

package/lib/settings/panel.d.ts

@@ -1,5 +1,4 @@
 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';
@@ -11,11 +10,12 @@ export declare const aiSettingsRenderer: (options: {
     secretsToken?: symbol;
     rmRegistry?: IRenderMimeRegistry;
     secretsManager?: ISecretsManager;
-    settingConnector?: ISettingConnector;
 }) => IFormRenderer;
 export interface ISettingsFormStates {
     schema: JSONSchema7;
     instruction: HTMLElement | null;
+    compatibilityError: string | null;
+    isModified?: boolean;
 }
 export declare class AiSettings extends React.Component<FieldProps, ISettingsFormStates> {
     constructor(props: FieldProps);
@@ -32,11 +32,23 @@ export declare class AiSettings extends React.Component<FieldProps, ISettingsFor
     /**
      * Get settings from local storage for a given 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 +69,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 +83,36 @@ 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 _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;
 }