Remove old autocomplete registry (#187)

Author: brichet

docs/source/developers/developing_extensions/extension-providing-chat.md

@@ -304,90 +304,6 @@ const myChatExtension: JupyterFrontEndPlugin<void> = {
 };
 ```
 
-(autocompletion-registry)=
-
-### autocompletionRegistry
-
-The `autocompletionRegistry` adds autocompletion feature to the chat input. This can be
-useful for automating chat messages reading, like in
-[jupyter-ai](https://github.com/jupyterlab/jupyter-ai).
-
-It uses the `Autocomplete` from
-[Material UI](https://mui.com/material-ui/react-autocomplete/),
-and can be customized using its [API](https://mui.com/material-ui/api/autocomplete/).
-
-Several _Autocompletion properties_ objects (implementing
-`IAutocompletionCommandsProps`) can be added to the registry.
-
-```{warning}
-Currently, only one *autocompletion properties* object can be used for a chat widget,
-even if several coexist in the registry.\
-The used one will be designed by the widget's option `autocompletionName`, otherwise a
-default will be used.
-```
-
-An _autocompletion properties_ object needs at least two properties:
-
-- **opener**, a character string that triggers the opening of the popup if entered at
-  the beginning of the input.\
-  For example typing `/` could open propositions like (`/ask`, `/help`, ...).
-- **commands**, a list of commands or a functions returning a list commands.
-
-```{tip}
-The *autocompletion command* is an object containing at least a `label` property, but
-which can also contain a `value` property.
-```
-
-```{tip}
-Adding the `renderOption` in the property `props` of the *autocompletion command* allows
-to customize the rendering of the entries. Some documentation about it can be found in
-the [Material UI API](https://mui.com/material-ui/api/autocomplete/).
-```
-
-Here is a simple example using a commands list (commands list copied from _jupyter-ai_):
-
-{emphasize-lines="2,6,12,13,14,15,16,17,18,25,26,32"}
-
-```typescript
-import {
-  AutocompletionRegistry,
-  ChatModel,
-  ChatWidget,
-  IChatMessage,
-  IAutocompletionCommandsProps,
-  INewMessage
-} from '@jupyter/chat';
-
-...
-
-const options = ['/ask', '/clear', '/export', '/generate', '/help', '/learn'];
-const autocompletionCommands: IAutocompletionCommandsProps = {
-  opener: '/',
-  commands: options.map(option => {
-    return { label: option };
-  })
-};
-
-const myChatExtension: JupyterFrontEndPlugin<void> = {
-  id: 'myExtension:plugin',
-  autoStart: true,
-  requires: [IRenderMimeRegistry],
-  activate: (app: JupyterFrontEnd, rmRegistry: IRenderMimeRegistry): void => {
-    const autocompletionRegistry = new AutocompletionRegistry();
-    autocompletionRegistry.add('default', autocompletionCommands);
-
-    const model = new MyModel();
-    const widget = new ChatWidget({
-      model,
-      rmRegistry,
-      autocompletionRegistry
-    });
-
-    app.shell.add(widget, 'right');
-  }
-};
-```
-
 (attachment-opener-registry)=
 
 ### attachmentOpenerRegistry

docs/source/developers/developing_extensions/using-chat-extension.md

@@ -36,13 +36,6 @@ This token is a pointer to the left panel containing chats.\
 It can be used to programmatically open chat in the panel for example, or to list the
 opened chats.
 
-### IAutocompletionRegistry
-
-This is the [autocompletion registry](#autocompletion-registry) used by the chat
-widgets.
-
-Autocompletion commands can be added to it, and then be used from the chat input.
-
 ## Interact with the chat from the backend
 
 `jupyter_collaboration` provides a websocket server to handle every shared document

packages/jupyter-chat/src/components/chat-input.tsx

@@ -19,7 +19,6 @@ import React, { useEffect, useRef, useState } from 'react';
 import { AttachmentPreviewList } from './attachments';
 import { AttachButton, CancelButton, SendButton } from './input';
 import { IInputModel, InputModel } from '../input-model';
-import { IAutocompletionRegistry } from '../registry';
 import { IAttachment, Selection } from '../types';
 import { useChatCommands } from './input/use-chat-commands';
 import { IChatCommandRegistry } from '../chat-commands';
@@ -297,14 +296,6 @@ export namespace ChatInput {
      * The document manager.
      */
     documentManager?: IDocumentManager;
-    /**
-     * Autocompletion properties.
-     */
-    autocompletionRegistry?: IAutocompletionRegistry;
-    /**
-     * Autocompletion name.
-     */
-    autocompletionName?: string;
     /**
      * Chat command registry.
      */

packages/jupyter-chat/src/components/chat.tsx

@@ -18,10 +18,7 @@ import { ChatMessages } from './chat-messages';
 import { ChatInput } from './chat-input';
 import { AttachmentOpenerContext } from '../context';
 import { IChatModel } from '../model';
-import {
-  IAttachmentOpenerRegistry,
-  IAutocompletionRegistry
-} from '../registry';
+import { IAttachmentOpenerRegistry } from '../registry';
 
 export function ChatBody(props: Chat.IChatBodyProps): JSX.Element {
   const { model } = props;
@@ -49,7 +46,6 @@ export function ChatBody(props: Chat.IChatBodyProps): JSX.Element {
         }}
         model={model.input}
         documentManager={props.documentManager}
-        autocompletionRegistry={props.autocompletionRegistry}
         chatCommandRegistry={props.chatCommandRegistry}
       />
     </AttachmentOpenerContext.Provider>
@@ -98,7 +94,6 @@ export function Chat(props: Chat.IOptions): JSX.Element {
             model={props.model}
             rmRegistry={props.rmRegistry}
             documentManager={props.documentManager}
-            autocompletionRegistry={props.autocompletionRegistry}
             chatCommandRegistry={props.chatCommandRegistry}
             attachmentOpenerRegistry={props.attachmentOpenerRegistry}
           />
@@ -131,14 +126,6 @@ export namespace Chat {
      * The document manager.
      */
     documentManager?: IDocumentManager;
-    /**
-     * Autocompletion registry.
-     */
-    autocompletionRegistry?: IAutocompletionRegistry;
-    /**
-     * Autocompletion name.
-     */
-    autocompletionName?: string;
     /**
      * Chat command registry.
      */

packages/jupyter-chat/src/registry.ts

@@ -3,130 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 import { Token } from '@lumino/coreutils';
-import { IAttachment, IAutocompletionCommandsProps } from './types';
-
-/**
- * The token for the autocomplete registry, which can be provided by an extension
- * using @jupyter/chat package.
- */
-export const IAutocompletionRegistry = new Token<IAutocompletionRegistry>(
-  '@jupyter/chat:IAutocompleteRegistry'
-);
-
-/**
- * The interface of a registry to provide autocompleters.
- */
-export interface IAutocompletionRegistry {
-  /**
-   * The default autocompletion name.
-   */
-  default: string | null;
-  /**
-   * Get the default autocompletion.
-   */
-  getDefaultCompletion(): IAutocompletionCommandsProps | undefined;
-  /**
-   * Return a registered autocomplete props.
-   *
-   * @param name - the name of the registered autocomplete props.
-   */
-  get(name: string): IAutocompletionCommandsProps | undefined;
-
-  /**
-   * Register autocomplete props.
-   *
-   * @param name - the name for the registration.
-   * @param autocompletion - the autocomplete props.
-   */
-  add(name: string, autocompletion: IAutocompletionCommandsProps): boolean;
-
-  /**
-   * Remove a registered autocomplete props.
-   *
-   * @param name - the name of the autocomplete props.
-   */
-  remove(name: string): boolean;
-}
-
-/**
- * A registry to provide autocompleters.
- */
-export class AutocompletionRegistry implements IAutocompletionRegistry {
-  /**
-   * Getter and setter for the default autocompletion name.
-   */
-  get default(): string | null {
-    return this._default;
-  }
-  set default(name: string | null) {
-    if (name === null || this._autocompletions.has(name)) {
-      this._default = name;
-    } else {
-      console.warn(`There is no registered completer with the name '${name}'`);
-    }
-  }
-
-  /**
-   * Get the default autocompletion.
-   */
-  getDefaultCompletion(): IAutocompletionCommandsProps | undefined {
-    if (this._default === null) {
-      return undefined;
-    }
-    return this._autocompletions.get(this._default);
-  }
-
-  /**
-   * Return a registered autocomplete props.
-   *
-   * @param name - the name of the registered autocomplete props.
-   */
-  get(name: string): IAutocompletionCommandsProps | undefined {
-    return this._autocompletions.get(name);
-  }
-
-  /**
-   * Register autocomplete props.
-   *
-   * @param name - the name for the registration.
-   * @param autocompletion - the autocomplete props.
-   */
-  add(
-    name: string,
-    autocompletion: IAutocompletionCommandsProps,
-    isDefault: boolean = false
-  ): boolean {
-    if (!this._autocompletions.has(name)) {
-      this._autocompletions.set(name, autocompletion);
-      if (this._autocompletions.size === 1 || isDefault) {
-        this.default = name;
-      }
-      return true;
-    } else {
-      console.warn(`A completer with the name '${name}' is already registered`);
-      return false;
-    }
-  }
-
-  /**
-   * Remove a registered autocomplete props.
-   *
-   * @param name - the name of the autocomplete props.
-   */
-  remove(name: string): boolean {
-    return this._autocompletions.delete(name);
-  }
-
-  /**
-   * Remove all registered autocompletions.
-   */
-  removeAll(): void {
-    this._autocompletions.clear();
-  }
-
-  private _default: string | null = null;
-  private _autocompletions = new Map<string, IAutocompletionCommandsProps>();
-}
+import { IAttachment } from './types';
 
 /**
  * The token for the attachments opener registry, which can be provided by an extension

packages/jupyter-chat/src/types.ts

@@ -95,13 +95,6 @@ export interface IAttachment {
  */
 export interface ISettings {} /* eslint-disable-line @typescript-eslint/no-empty-object-type */
 
-/**
- * The autocomplete command type.
- */
-export type AutocompleteCommand = {
-  label: string;
-};
-
 /**
  * Representation of a selected text.
  */
@@ -122,35 +115,3 @@ export type CellSelection = {
  * Selection object (text or cell).
  */
 export type Selection = TextSelection | CellSelection;
-
-/**
- * The properties of the autocompletion.
- *
- * The autocompletion component will open if the 'opener' string is typed at the
- * beginning of the input field.
- */
-export interface IAutocompletionCommandsProps {
-  /**
-   * The string that open the completer.
-   */
-  opener: string;
-  /**
-   * The list of available commands.
-   */
-  commands?: AutocompleteCommand[] | (() => Promise<AutocompleteCommand[]>);
-  /**
-   * The props for the Autocomplete component.
-   *
-   * Must be compatible with https://mui.com/material-ui/api/autocomplete/#props.
-   *
-   * ## NOTES:
-   * - providing `options` will overwrite the commands argument.
-   * - providing `renderInput` will overwrite the input component.
-   * - providing `renderOptions` allows to customize the rendering of the component.
-   * - some arguments should not be provided and would be overwritten:
-   *   - inputValue
-   *   - onInputChange
-   *   - onHighlightChange
-   */
-  props?: any;
-}