@jupyter/chat 0.7.0 → 0.8.0

package/lib/input-model.js

@@ -0,0 +1,217 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { Signal } from '@lumino/signaling';
+const WHITESPACE = new Set([' ', '\n', '\t']);
+/**
+ * The input model.
+ */
+export class InputModel {
+    constructor(options) {
+        var _a, _b;
+        /**
+         * Add attachment to send with next message.
+         */
+        this.addAttachment = (attachment) => {
+            const duplicateAttachment = this._attachments.find(att => att.type === attachment.type && att.value === attachment.value);
+            if (duplicateAttachment) {
+                return;
+            }
+            this._attachments.push(attachment);
+            this._attachmentsChanged.emit([...this._attachments]);
+        };
+        /**
+         * Remove attachment to be sent.
+         */
+        this.removeAttachment = (attachment) => {
+            const attachmentIndex = this._attachments.findIndex(att => att.type === attachment.type && att.value === attachment.value);
+            if (attachmentIndex === -1) {
+                return;
+            }
+            this._attachments.splice(attachmentIndex, 1);
+            this._attachmentsChanged.emit([...this._attachments]);
+        };
+        /**
+         * Update attachments.
+         */
+        this.clearAttachments = () => {
+            this._attachments = [];
+            this._attachmentsChanged.emit([]);
+        };
+        this._cursorIndex = null;
+        this._currentWord = null;
+        this._valueChanged = new Signal(this);
+        this._cursorIndexChanged = new Signal(this);
+        this._currentWordChanged = new Signal(this);
+        this._configChanged = new Signal(this);
+        this._focusInputSignal = new Signal(this);
+        this._attachmentsChanged = new Signal(this);
+        this._isDisposed = false;
+        this._value = options.value || '';
+        this._attachments = options.attachments || [];
+        this.cursorIndex = options.cursorIndex || this.value.length;
+        this._activeCellManager = (_a = options.activeCellManager) !== null && _a !== void 0 ? _a : null;
+        this._selectionWatcher = (_b = options.selectionWatcher) !== null && _b !== void 0 ? _b : null;
+        this._config = {
+            ...options.config
+        };
+    }
+    /**
+     * The entire input value.
+     */
+    get value() {
+        return this._value;
+    }
+    set value(newInput) {
+        this._value = newInput;
+        this._valueChanged.emit(newInput);
+    }
+    /**
+     * A signal emitting when the value has changed.
+     */
+    get valueChanged() {
+        return this._valueChanged;
+    }
+    /**
+     * The cursor position in the input.
+     */
+    get cursorIndex() {
+        return this._cursorIndex;
+    }
+    set cursorIndex(newIndex) {
+        if (newIndex === null || newIndex > this._value.length) {
+            return;
+        }
+        this._cursorIndex = newIndex;
+        this._cursorIndexChanged.emit(newIndex);
+        if (this._cursorIndex === null) {
+            return;
+        }
+        const currentWord = Private.getCurrentWord(this._value, this._cursorIndex);
+        if (currentWord !== this._currentWord) {
+            this._currentWord = currentWord;
+            this._currentWordChanged.emit(this._currentWord);
+        }
+    }
+    /**
+     * A signal emitting when the cursor position has changed.
+     */
+    get cursorIndexChanged() {
+        return this._cursorIndexChanged;
+    }
+    /**
+     * The current word behind the user's cursor, space-separated.
+     */
+    get currentWord() {
+        return this._currentWord;
+    }
+    /**
+     * A signal emitting when the current word has changed.
+     */
+    get currentWordChanged() {
+        return this._currentWordChanged;
+    }
+    /**
+     * Get the active cell manager.
+     */
+    get activeCellManager() {
+        return this._activeCellManager;
+    }
+    /**
+     * Get the selection watcher.
+     */
+    get selectionWatcher() {
+        return this._selectionWatcher;
+    }
+    /**
+     * The input configuration.
+     */
+    get config() {
+        return this._config;
+    }
+    set config(value) {
+        this._config = { ...this._config, ...value };
+        this._configChanged.emit(this._config);
+    }
+    /**
+     * A signal emitting when the configuration is updated.
+     */
+    get configChanged() {
+        return this._configChanged;
+    }
+    /**
+     * Function to request the focus on the input of the chat.
+     */
+    focus() {
+        this._focusInputSignal.emit();
+    }
+    /**
+     * A signal emitting when the focus is requested on the input.
+     */
+    get focusInputSignal() {
+        return this._focusInputSignal;
+    }
+    /**
+     * The attachments list.
+     */
+    get attachments() {
+        return this._attachments;
+    }
+    /**
+     * A signal emitting when the input attachments changed.
+     */
+    get attachmentsChanged() {
+        return this._attachmentsChanged;
+    }
+    /**
+     * Replace the current word in the input with a new one.
+     */
+    replaceCurrentWord(newWord) {
+        if (this.cursorIndex === null) {
+            return;
+        }
+        const [start, end] = Private.getCurrentWordBoundaries(this.value, this.cursorIndex);
+        this.value = this.value.slice(0, start) + newWord + this.value.slice(end);
+    }
+    /**
+     * Dispose the input model.
+     */
+    dispose() {
+        if (this.isDisposed) {
+            return;
+        }
+        this._isDisposed = true;
+    }
+    /**
+     * Whether the input model is disposed.
+     */
+    get isDisposed() {
+        return this._isDisposed;
+    }
+}
+var Private;
+(function (Private) {
+    function getCurrentWordBoundaries(input, cursorIndex) {
+        let start = cursorIndex;
+        let end = cursorIndex;
+        const n = input.length;
+        while (start > 0 && !WHITESPACE.has(input[start - 1])) {
+            start--;
+        }
+        while (end < n && !WHITESPACE.has(input[end])) {
+            end++;
+        }
+        return [start, end];
+    }
+    Private.getCurrentWordBoundaries = getCurrentWordBoundaries;
+    /**
+     * Gets the current (space-separated) word around the user's cursor. The current
+     * word is used to generate a list of matching chat commands.
+     */
+    function getCurrentWord(input, cursorIndex) {
+        const [start, end] = getCurrentWordBoundaries(input, cursorIndex);
+        return input.slice(start, end);
+    }
+    Private.getCurrentWord = getCurrentWord;
+})(Private || (Private = {}));

package/lib/model.d.ts

@@ -4,6 +4,7 @@ import { ISignal } from '@lumino/signaling';
 import { IChatHistory, INewMessage, IChatMessage, IConfig, IUser } from './types';
 import { IActiveCellManager } from './active-cell-manager';
 import { ISelectionWatcher } from './selection-watcher';
+import { IInputModel } from './input-model';
 /**
  * The chat model interface.
  */
@@ -32,6 +33,10 @@ export interface IChatModel extends IDisposable {
      * The chat messages list.
      */
     readonly messages: IChatMessage[];
+    /**
+     * The input model.
+     */
+    readonly input: IInputModel;
     /**
      * Get the active cell manager.
      */
@@ -60,10 +65,6 @@ export interface IChatModel extends IDisposable {
      * A signal emitting when the writers change.
      */
     readonly writersChanged?: ISignal<IChatModel, IUser[]>;
-    /**
-     * A signal emitting when the focus is requested on the input.
-     */
-    readonly focusInputSignal?: ISignal<IChatModel, void>;
     /**
      * Send a message, to be defined depending on the chosen technology.
      * Default to no-op.
@@ -121,14 +122,6 @@ export interface IChatModel extends IDisposable {
      * Update the current writers list.
      */
     updateWriters(writers: IUser[]): void;
-    /**
-     * Function to request the focus on the input of the chat.
-     */
-    focusInput(): void;
-    /**
-     * Function called by the input on key pressed.
-     */
-    inputChanged?(input?: string): void;
 }
 /**
  * The default chat model implementation.
@@ -154,6 +147,10 @@ export declare class ChatModel implements IChatModel {
      * The chat messages list.
      */
     get messages(): IChatMessage[];
+    /**
+     * The input model.
+     */
+    get input(): IInputModel;
     /**
      * Get the active cell manager.
      */
@@ -202,10 +199,6 @@ export declare class ChatModel implements IChatModel {
      * A signal emitting when the writers change.
      */
     get writersChanged(): ISignal<IChatModel, IUser[]>;
-    /**
-     * A signal emitting when the focus is requested on the input.
-     */
-    get focusInputSignal(): ISignal<IChatModel, void>;
     /**
      * Send a message, to be defined depending on the chosen technology.
      * Default to no-op.
@@ -252,14 +245,6 @@ export declare class ChatModel implements IChatModel {
      * This implementation only propagate the list via a signal.
      */
     updateWriters(writers: IUser[]): void;
-    /**
-     * Function to request the focus on the input of the chat.
-     */
-    focusInput(): void;
-    /**
-     * Function called by the input on key pressed.
-     */
-    inputChanged?(input?: string): void;
     /**
      * Add unread messages to the list.
      * @param indexes - list of new indexes.
@@ -281,6 +266,7 @@ export declare class ChatModel implements IChatModel {
     private _id;
     private _name;
     private _config;
+    private _inputModel;
     private _isDisposed;
     private _commands?;
     private _activeCellManager;
@@ -291,7 +277,6 @@ export declare class ChatModel implements IChatModel {
     private _unreadChanged;
     private _viewportChanged;
     private _writersChanged;
-    private _focusInputSignal;
 }
 /**
  * The chat model namespace.

package/lib/model.js

@@ -3,6 +3,7 @@
  * Distributed under the terms of the Modified BSD License.
  */
 import { Signal } from '@lumino/signaling';
+import { InputModel } from './input-model';
 /**
  * The default chat model implementation.
  * It is not able to send or update a message by itself, since it depends on the
@@ -25,7 +26,6 @@ export class ChatModel {
         this._unreadChanged = new Signal(this);
         this._viewportChanged = new Signal(this);
         this._writersChanged = new Signal(this);
-        this._focusInputSignal = new Signal(this);
         if (options.id) {
             this.id = options.id;
         }
@@ -36,6 +36,13 @@ export class ChatModel {
             sendTypingNotification: true,
             ...config
         };
+        this._inputModel = new InputModel({
+            activeCellManager: options.activeCellManager,
+            selectionWatcher: options.selectionWatcher,
+            config: {
+                sendWithShiftEnter: config.sendWithShiftEnter
+            }
+        });
         this._commands = options.commands;
         this._activeCellManager = (_b = options.activeCellManager) !== null && _b !== void 0 ? _b : null;
         this._selectionWatcher = (_c = options.selectionWatcher) !== null && _c !== void 0 ? _c : null;
@@ -64,6 +71,12 @@ export class ChatModel {
     get messages() {
         return this._messages;
     }
+    /**
+     * The input model.
+     */
+    get input() {
+        return this._inputModel;
+    }
     /**
      * Get the active cell manager.
      */
@@ -108,6 +121,7 @@ export class ChatModel {
             this._config.unreadNotifications !== value.unreadNotifications;
         this._config = { ...this._config, ...value };
         this._configChanged.emit(this._config);
+        this.input.config = value;
         // Update the stacked status of the messages and the view.
         if (stackMessagesChanged) {
             if (this._config.stackMessages) {
@@ -197,12 +211,6 @@ export class ChatModel {
     get writersChanged() {
         return this._writersChanged;
     }
-    /**
-     * A signal emitting when the focus is requested on the input.
-     */
-    get focusInputSignal() {
-        return this._focusInputSignal;
-    }
     /**
      * Send a message, to be defined depending on the chosen technology.
      * Default to no-op.
@@ -306,16 +314,6 @@ export class ChatModel {
     updateWriters(writers) {
         this._writersChanged.emit(writers);
     }
-    /**
-     * Function to request the focus on the input of the chat.
-     */
-    focusInput() {
-        this._focusInputSignal.emit();
-    }
-    /**
-     * Function called by the input on key pressed.
-     */
-    inputChanged(input) { }
     /**
      * Add unread messages to the list.
      * @param indexes - list of new indexes.

package/lib/registry.d.ts

@@ -1,78 +1,25 @@
 import { Token } from '@lumino/coreutils';
-import { IAutocompletionCommandsProps } from './types';
+import { IAttachment } from './types';
 /**
- * The token for the autocomplete registry, which can be provided by an extension
+ * The token for the attachments opener registry, which can be provided by an extension
  * using @jupyter/chat package.
  */
-export declare const IAutocompletionRegistry: Token<IAutocompletionRegistry>;
+export declare const IAttachmentOpenerRegistry: Token<IAttachmentOpenerRegistry>;
 /**
- * The interface of a registry to provide autocompleters.
+ * The interface of a registry to provide attachments opener.
  */
-export interface IAutocompletionRegistry {
+export interface IAttachmentOpenerRegistry {
     /**
-     * The default autocompletion name.
+     * Get the function opening an attachment for a given type.
      */
-    default: string | null;
+    get(type: string): ((attachment: IAttachment) => void) | undefined;
     /**
-     * Get the default autocompletion.
+     * Register a function to open an attachment type.
      */
-    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;
+    set(type: string, opener: (attachment: IAttachment) => void): void;
 }
 /**
- * A registry to provide autocompleters.
+ * The default registry, a Map object.
  */
-export declare class AutocompletionRegistry implements IAutocompletionRegistry {
-    /**
-     * Getter and setter for the default autocompletion name.
-     */
-    get default(): string | null;
-    set default(name: 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, isDefault?: boolean): boolean;
-    /**
-     * Remove a registered autocomplete props.
-     *
-     * @param name - the name of the autocomplete props.
-     */
-    remove(name: string): boolean;
-    /**
-     * Remove all registered autocompletions.
-     */
-    removeAll(): void;
-    private _default;
-    private _autocompletions;
+export declare class AttachmentOpenerRegistry extends Map<string, (attachment: IAttachment) => void> implements IAttachmentOpenerRegistry {
 }

package/lib/registry.js

@@ -4,80 +4,12 @@
  */
 import { Token } from '@lumino/coreutils';
 /**
- * The token for the autocomplete registry, which can be provided by an extension
+ * The token for the attachments opener registry, which can be provided by an extension
  * using @jupyter/chat package.
  */
-export const IAutocompletionRegistry = new Token('@jupyter/chat:IAutocompleteRegistry');
+export const IAttachmentOpenerRegistry = new Token('@jupyter/chat:IAttachmentOpenerRegistry');
 /**
- * A registry to provide autocompleters.
+ * The default registry, a Map object.
  */
-export class AutocompletionRegistry {
-    constructor() {
-        this._default = null;
-        this._autocompletions = new Map();
-    }
-    /**
-     * Getter and setter for the default autocompletion name.
-     */
-    get default() {
-        return this._default;
-    }
-    set default(name) {
-        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() {
-        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) {
-        return this._autocompletions.get(name);
-    }
-    /**
-     * Register autocomplete props.
-     *
-     * @param name - the name for the registration.
-     * @param autocompletion - the autocomplete props.
-     */
-    add(name, autocompletion, isDefault = false) {
-        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) {
-        return this._autocompletions.delete(name);
-    }
-    /**
-     * Remove all registered autocompletions.
-     */
-    removeAll() {
-        this._autocompletions.clear();
-    }
+export class AttachmentOpenerRegistry extends Map {
 }

package/lib/types.d.ts

@@ -37,12 +37,13 @@ export interface IConfig {
 /**
  * The chat message description.
  */
-export interface IChatMessage<T = IUser> {
+export interface IChatMessage<T = IUser, U = IAttachment> {
     type: 'msg';
     body: string;
     id: string;
     time: number;
     sender: T;
+    attachments?: U[];
     raw_time?: boolean;
     deleted?: boolean;
     edited?: boolean;
@@ -62,16 +63,27 @@ export interface INewMessage {
     id?: string;
 }
 /**
- * An empty interface to describe optional settings that could be fetched from server.
+ * The attachment interface.
  */
-export interface ISettings {
+export interface IAttachment {
+    /**
+     * The type of the attachment (basically 'file', 'variable', 'image')
+     */
+    type: string;
+    /**
+     * The value, i.e. the file path, the variable name or image content.
+     */
+    value: string;
+    /**
+     * The mimetype of the attachment, optional.
+     */
+    mimetype?: string;
 }
 /**
- * The autocomplete command type.
+ * An empty interface to describe optional settings that could be fetched from server.
  */
-export type AutocompleteCommand = {
-    label: string;
-};
+export interface ISettings {
+}
 /**
  * Representation of a selected text.
  */
@@ -90,34 +102,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;
-}

package/lib/widgets/chat-widget.js

@@ -9,10 +9,11 @@ import { chatIcon } from '../icons';
 export class ChatWidget extends ReactWidget {
     constructor(options) {
         super();
-        this.id = 'jupyter-chat::widget';
         this.title.icon = chatIcon;
         this.title.caption = 'Jupyter Chat'; // TODO: i18n
         this._chatOptions = options;
+        this.id = `jupyter-chat::widget::${options.model.name}`;
+        this.node.onclick = () => this.model.input.focus();
     }
     /**
      * Get the model of the widget.