@jupyterlite/ai 0.8.0 → 0.9.0-a0

package/lib/provider.js

@@ -1,412 +0,0 @@
-import { Notification } from '@jupyterlab/apputils';
-import { Debouncer } from '@lumino/polling';
-import { Signal } from '@lumino/signaling';
-import { getSecretId, SECRETS_REPLACEMENT } from './settings';
-import { PLUGIN_IDS } from './tokens';
-const SECRETS_NAMESPACE = PLUGIN_IDS.providerRegistry;
-const NOTIFICATION_DELAY = 2000;
-export class AIProviderRegistry {
-    /**
-     * The constructor of the provider registry.
-     */
-    constructor(options) {
-        this._secretsManager = options.secretsManager || null;
-        Private.setToken(options.token);
-        this._notifications = {
-            chat: new Debouncer(this._emitErrorNotification, NOTIFICATION_DELAY),
-            completer: new Debouncer(this._emitErrorNotification, NOTIFICATION_DELAY)
-        };
-    }
-    /**
-     * Get the list of provider names.
-     */
-    get providers() {
-        return Array.from(Private.providers.keys());
-    }
-    /**
-     * Add a new provider.
-     */
-    add(provider) {
-        if (Private.providers.has(provider.name)) {
-            throw new Error(`A AI provider named '${provider.name}' is already registered`);
-        }
-        Private.providers.set(provider.name, provider);
-        // Set the providers if the loading has been deferred.
-        if (provider.name === this._deferredProvider.completer?.name) {
-            this.setCompleterProvider(this._deferredProvider.completer);
-        }
-        if (provider.name === this._deferredProvider.chat?.name) {
-            this.setChatProvider(this._deferredProvider.chat);
-        }
-    }
-    /**
-     * Get the current provider name.
-     */
-    currentName(role) {
-        return Private.getName(role);
-    }
-    /**
-     * Get the current AICompleter.
-     */
-    get currentCompleter() {
-        if (Private.getName('completer') === 'None') {
-            return null;
-        }
-        const completer = Private.getCompleter();
-        if (completer === null) {
-            return null;
-        }
-        return {
-            fetch: (request, context) => completer.fetch(request, context)
-        };
-    }
-    /**
-     * Getter/setter for the completer system prompt.
-     */
-    get completerSystemPrompt() {
-        return this._completerPrompt.replaceAll('$provider_name$', this.currentName('completer'));
-    }
-    set completerSystemPrompt(value) {
-        this._completerPrompt = value;
-    }
-    /**
-     * Get the current AIChatModel.
-     */
-    get currentChatModel() {
-        if (Private.getName('chat') === 'None') {
-            return null;
-        }
-        const currentProvider = Private.providers.get(Private.getName('chat')) ?? null;
-        const chatModel = Private.getChatModel();
-        if (chatModel === null) {
-            return null;
-        }
-        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)
-        };
-    }
-    /**
-     * Getter/setter for the chat system prompt.
-     */
-    get chatSystemPrompt() {
-        return this._chatPrompt.replaceAll('$provider_name$', this.currentName('chat'));
-    }
-    set chatSystemPrompt(value) {
-        this._chatPrompt = value;
-    }
-    /**
-     * Get the settings schema of a given provider.
-     */
-    getSettingsSchema(provider) {
-        return (Private.providers.get(provider)?.settingsSchema?.properties ||
-            {});
-    }
-    /**
-     * Get the instructions of a given provider.
-     */
-    getInstructions(provider) {
-        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) {
-        const currentProvider = Private.providers.get(Private.getName('chat')) ?? null;
-        if (currentProvider?.errorMessage) {
-            return currentProvider?.errorMessage(error);
-        }
-        if (error.message) {
-            return error.message;
-        }
-        return error;
-    }
-    /**
-     * Get/set the current chat error;
-     */
-    get chatError() {
-        return this._chatError;
-    }
-    set chatError(error) {
-        this._chatError = error;
-        if (error !== '') {
-            this._notifications.chat.invoke(`Chat: ${error}`);
-        }
-    }
-    /**
-     * Get/set the current completer error.
-     */
-    get completerError() {
-        return this._completerError;
-    }
-    set completerError(error) {
-        this._completerError = error;
-        if (error !== '') {
-            this._notifications.completer.invoke(`Completer: ${error}`);
-        }
-    }
-    /**
-     * A function to emit a notification error.
-     */
-    _emitErrorNotification(error) {
-        Notification.emit(error, 'error', {
-            autoClose: NOTIFICATION_DELAY
-        });
-    }
-    /**
-     * Set the completer provider.
-     * Creates the provider if the name has changed, otherwise only updates its config.
-     *
-     * @param options - An object with the name and the settings of the provider to use.
-     */
-    async setCompleterProvider(settings) {
-        this.completerError = '';
-        if (!Object.keys(settings).includes('provider')) {
-            Private.setName('completer', 'None');
-            Private.setCompleter(null);
-            this.completerError =
-                'The provider is missing from the completer settings';
-            return;
-        }
-        const provider = settings['provider'];
-        const currentProvider = Private.providers.get(provider) ?? 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.completer = settings;
-            Private.setName('completer', provider);
-            Private.setCompleter(null);
-            return;
-        }
-        else {
-            this._deferredProvider.completer = null;
-        }
-        const compatibilityCheck = this.getCompatibilityCheck(provider);
-        if (compatibilityCheck !== undefined) {
-            const error = await compatibilityCheck();
-            if (error !== null) {
-                this.completerError = error.trim();
-                Private.setName('completer', 'None');
-                this._providerChanged.emit('completer');
-                return;
-            }
-        }
-        // Get the settings including the secrets.
-        const fullSettings = await this._buildFullSettings(provider, settings);
-        if (currentProvider?.completer !== undefined) {
-            try {
-                Private.setCompleter(new currentProvider.completer({
-                    providerRegistry: this,
-                    settings: fullSettings
-                }));
-            }
-            catch (e) {
-                this.completerError = e.message;
-            }
-        }
-        else {
-            Private.setCompleter(null);
-        }
-        Private.setName('completer', provider);
-        this._providerChanged.emit('completer');
-    }
-    /**
-     * Set the chat provider.
-     * Creates the provider if the name has changed, otherwise only updates its config.
-     *
-     * @param options - An object with the name and the settings of the provider to use.
-     */
-    async setChatProvider(settings) {
-        this.chatError = '';
-        if (!Object.keys(settings).includes('provider')) {
-            Private.setName('chat', 'None');
-            Private.setChatModel(null);
-            this.chatError = 'The provider is missing from the chat settings';
-            return;
-        }
-        const provider = settings['provider'];
-        const currentProvider = Private.providers.get(provider) ?? 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.chat = settings;
-            Private.setName('chat', provider);
-            Private.setChatModel(null);
-            return;
-        }
-        else {
-            this._deferredProvider.chat = null;
-        }
-        const compatibilityCheck = this.getCompatibilityCheck(provider);
-        if (compatibilityCheck !== undefined) {
-            const error = await compatibilityCheck();
-            if (error !== null) {
-                this.chatError = error.trim();
-                Private.setName('chat', 'None');
-                this._providerChanged.emit('chat');
-                return;
-            }
-        }
-        // Get the settings including the secrets.
-        const fullSettings = await this._buildFullSettings(provider, settings);
-        if (currentProvider?.chat !== undefined) {
-            try {
-                Private.setChatModel(new currentProvider.chat({
-                    ...fullSettings
-                }));
-            }
-            catch (e) {
-                this.chatError = e.message;
-                Private.setChatModel(null);
-            }
-        }
-        else {
-            Private.setChatModel(null);
-        }
-        Private.setName('chat', provider);
-        this._providerChanged.emit('chat');
-    }
-    /**
-     * A signal emitting when the provider or its settings has changed.
-     */
-    get providerChanged() {
-        return this._providerChanged;
-    }
-    /**
-     * Build a new settings object containing the secrets.
-     */
-    async _buildFullSettings(name, settings) {
-        // 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 this._secretsManager?.get(Private.getToken(), SECRETS_NAMESPACE, id);
-                if (secrets !== undefined) {
-                    fullSettings[key] = secrets.value;
-                }
-                continue;
-            }
-            fullSettings[key] = settings[key];
-        }
-        return fullSettings;
-    }
-    _secretsManager;
-    _providerChanged = new Signal(this);
-    _chatError = '';
-    _completerError = '';
-    _notifications;
-    _deferredProvider = {
-        chat: null,
-        completer: null
-    };
-    _chatPrompt = '';
-    _completerPrompt = '';
-}
-(function (AIProviderRegistry) {
-    /**
-     * This function indicates whether a key is writable in an object.
-     * https://stackoverflow.com/questions/54724875/can-we-check-whether-property-is-readonly-in-typescript
-     *
-     * @param obj - An object extending the BaseLanguageModel interface.
-     * @param key - A string as a key of the object.
-     * @returns a boolean whether the key is writable or not.
-     */
-    function isWritable(obj, key) {
-        const desc = Object.getOwnPropertyDescriptor(obj, key) ||
-            Object.getOwnPropertyDescriptor(Object.getPrototypeOf(obj), key) ||
-            {};
-        return Boolean(desc.writable);
-    }
-    AIProviderRegistry.isWritable = isWritable;
-    /**
-     * Update the config of a language model.
-     * It only updates the writable attributes of the model.
-     *
-     * @param model - the model to update.
-     * @param settings - the configuration s a JSON object.
-     */
-    function updateConfig(model, settings) {
-        Object.entries(settings).forEach(([key, value], index) => {
-            if (key in model) {
-                const modelKey = key;
-                if (isWritable(model, modelKey)) {
-                    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                    // @ts-ignore
-                    model[modelKey] = value;
-                }
-            }
-        });
-    }
-    AIProviderRegistry.updateConfig = updateConfig;
-})(AIProviderRegistry || (AIProviderRegistry = {}));
-var Private;
-(function (Private) {
-    /**
-     * The token to use with the secrets manager, setter and getter.
-     */
-    let secretsToken;
-    function setToken(value) {
-        secretsToken = value;
-    }
-    Private.setToken = setToken;
-    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.
-     */
-    const names = {
-        chat: 'None',
-        completer: 'None'
-    };
-    function setName(role, value) {
-        names[role] = value;
-    }
-    Private.setName = setName;
-    function getName(role) {
-        return names[role];
-    }
-    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/base.json

@@ -1,7 +0,0 @@
-{
-    "title": "AI provider",
-    "description": "Provider settings",
-    "type": "object",
-    "properties": {},
-    "additionalProperties": false
-}

package/lib/settings/index.d.ts

@@ -1,3 +0,0 @@
-export * from './panel';
-export * from './textarea';
-export * from './utils';

package/lib/settings/index.js

@@ -1,3 +0,0 @@
-export * from './panel';
-export * from './textarea';
-export * from './utils';

package/lib/settings/panel.d.ts

@@ -1,226 +0,0 @@
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-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, ModelRole } from '../tokens';
-export declare const aiSettingsRenderer: (options: {
-    providerRegistry: IAIProviderRegistry;
-    secretsToken?: symbol;
-    rmRegistry?: IRenderMimeRegistry;
-    secretsManager?: ISecretsManager;
-}) => IFormRenderer;
-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, 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;
-    /**
-     * Get the current provider from the local storage.
-     */
-    getCurrentProvider(): string;
-    /**
-     * Save the current provider to the local storage.
-     */
-    saveCurrentProvider(): void;
-    /**
-     * Get settings from local storage for the current provider provider.
-     */
-    getSettingsFromLocalStorage(): IDict<any>;
-    /**
-     * Save settings in local storage for a given provider.
-     */
-    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.
-     *
-     * @param value - whether to use the secrets manager or not.
-     */
-    private _updateUseSecretsManager;
-    /**
-     * Build the schema for a given provider.
-     */
-    private _buildSchema;
-    /**
-     * Update the schema state for the given provider, that trigger the re-rendering of
-     * the component.
-     */
-    private _updateSchema;
-    /**
-     * Render the markdown instructions for the current provider.
-     */
-    private _renderInstruction;
-    /**
-     * 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;
-    /**
-     * Callback function called when the password input has been programmatically updated
-     * 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 _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 _rmRegistry;
-    private _secretsManager;
-    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 {};