@jupyter/chat 0.1.0 → 0.2.0

package/lib/registry.d.ts

@@ -0,0 +1,78 @@
+import { Token } from '@lumino/coreutils';
+import { IAutocompletionCommandsProps } from './types';
+/**
+ * The token for the autocomplete registry, which can be provided by an extension
+ * using @jupyter/chat package.
+ */
+export declare const IAutocompletionRegistry: Token<IAutocompletionRegistry>;
+/**
+ * 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 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;
+}

package/lib/registry.js

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { Token } from '@lumino/coreutils';
+/**
+ * The token for the autocomplete registry, which can be provided by an extension
+ * using @jupyter/chat package.
+ */
+export const IAutocompletionRegistry = new Token('@jupyter/chat:IAutocompleteRegistry');
+/**
+ * A registry to provide autocompleters.
+ */
+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();
+    }
+}

package/lib/types.d.ts

@@ -13,21 +13,36 @@ export interface IUser {
  * The configuration interface.
  */
 export interface IConfig {
+    /**
+     * Whether to send a message via Shift-Enter instead of Enter.
+     */
     sendWithShiftEnter?: boolean;
+    /**
+     * Last read message (no use yet).
+     */
     lastRead?: number;
+    /**
+     * Whether to stack consecutive messages from same user.
+     */
+    stackMessages?: boolean;
+    /**
+     * Whether to enable or not the notifications on unread messages.
+     */
+    unreadNotifications?: boolean;
 }
 /**
- * The chat message decription.
+ * The chat message description.
  */
-export interface IChatMessage {
+export interface IChatMessage<T = IUser> {
     type: 'msg';
     body: string;
     id: string;
     time: number;
-    sender: IUser | string;
+    sender: T;
     raw_time?: boolean;
     deleted?: boolean;
     edited?: boolean;
+    stacked?: boolean;
 }
 /**
  * The chat history interface.
@@ -43,7 +58,44 @@ export interface INewMessage {
     id?: string;
 }
 /**
- * An empty interface to describe optional settings taht could be fetched from server.
+ * An empty interface to describe optional settings that could be fetched from server.
  */
 export interface ISettings {
 }
+/**
+ * The autocomplete command type.
+ */
+export type AutocompleteCommand = {
+    label: string;
+};
+/**
+ * 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-sidebar.d.ts

@@ -1,4 +1,3 @@
-import { IThemeManager, ReactWidget } from '@jupyterlab/apputils';
-import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
-import { IChatModel } from '../model';
-export declare function buildChatSidebar(chatModel: IChatModel, themeManager: IThemeManager | null, rmRegistry: IRenderMimeRegistry): ReactWidget;
+import { ReactWidget } from '@jupyterlab/apputils';
+import { Chat } from '../components/chat';
+export declare function buildChatSidebar(options: Chat.IOptions): ReactWidget;

package/lib/widgets/chat-sidebar.js

@@ -6,8 +6,8 @@ import { ReactWidget } from '@jupyterlab/apputils';
 import React from 'react';
 import { Chat } from '../components/chat';
 import { chatIcon } from '../icons';
-export function buildChatSidebar(chatModel, themeManager, rmRegistry) {
-    const ChatWidget = ReactWidget.create(React.createElement(Chat, { model: chatModel, themeManager: themeManager, rmRegistry: rmRegistry }));
+export function buildChatSidebar(options) {
+    const ChatWidget = ReactWidget.create(React.createElement(Chat, { ...options }));
     ChatWidget.id = 'jupyter-chat::side-panel';
     ChatWidget.title.icon = chatIcon;
     ChatWidget.title.caption = 'Jupyter Chat'; // TODO: i18n

package/lib/widgets/chat-widget.d.ts

@@ -5,15 +5,9 @@ import { IChatModel } from '../model';
 export declare class ChatWidget extends ReactWidget {
     constructor(options: Chat.IOptions);
     /**
-     * Gte the model of the widget.
+     * Get the model of the widget.
      */
     get model(): IChatModel;
     render(): React.JSX.Element;
-    private readonly _model;
-    private _themeManager;
-    private _rmRegistry;
-}
-export declare namespace ChatWidget {
-    interface IOptions extends Chat.IOptions {
-    }
+    private _chatOptions;
 }

package/lib/widgets/chat-widget.js

@@ -12,17 +12,17 @@ export class ChatWidget extends ReactWidget {
         this.id = 'jupyter-chat::widget';
         this.title.icon = chatIcon;
         this.title.caption = 'Jupyter Chat'; // TODO: i18n
-        this._model = options.model;
-        this._themeManager = (options === null || options === void 0 ? void 0 : options.themeManager) || null;
-        this._rmRegistry = options.rmRegistry;
+        this._chatOptions = options;
     }
     /**
-     * Gte the model of the widget.
+     * Get the model of the widget.
      */
     get model() {
-        return this._model;
+        return this._chatOptions.model;
     }
     render() {
-        return (React.createElement(Chat, { model: this._model, themeManager: this._themeManager, rmRegistry: this._rmRegistry }));
+        // The model need to be passed, otherwise it is undefined in the widget in
+        // the case of collaborative document.
+        return React.createElement(Chat, { ...this._chatOptions, model: this._chatOptions.model });
     }
 }