jupyter-chat-example 0.8.0

package/README.md

@@ -0,0 +1,3 @@
+# jupyter-chat-example
+
+A simple extension providing a chat side bar.

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+declare const _default: JupyterFrontEndPlugin<void>[];
+export default _default;

package/lib/index.js

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { ActiveCellManager, AttachmentOpenerRegistry, buildChatSidebar, ChatModel, SelectionWatcher } from '@jupyter/chat';
+import { IThemeManager } from '@jupyterlab/apputils';
+import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { UUID } from '@lumino/coreutils';
+class MyChatModel extends ChatModel {
+    sendMessage(newMessage) {
+        var _a;
+        const message = {
+            body: newMessage.body,
+            id: (_a = newMessage.id) !== null && _a !== void 0 ? _a : UUID.uuid4(),
+            type: 'msg',
+            time: Date.now() / 1000,
+            sender: { username: 'me' },
+            attachments: this.input.attachments
+        };
+        this.messageAdded(message);
+        this.input.clearAttachments();
+    }
+}
+/*
+ * Extension providing a chat panel.
+ */
+const plugin = {
+    id: 'jupyter-chat-example:plugin',
+    description: 'The chat panel widget.',
+    autoStart: true,
+    requires: [IRenderMimeRegistry],
+    optional: [
+        IDefaultFileBrowser,
+        INotebookTracker,
+        ISettingRegistry,
+        IThemeManager
+    ],
+    activate: (app, rmRegistry, filebrowser, notebookTracker, settingRegistry, themeManager) => {
+        // Track the current active cell.
+        let activeCellManager = null;
+        if (notebookTracker) {
+            activeCellManager = new ActiveCellManager({
+                tracker: notebookTracker,
+                shell: app.shell
+            });
+        }
+        // Track the current selection.
+        const selectionWatcher = new SelectionWatcher({
+            shell: app.shell
+        });
+        const model = new MyChatModel({ activeCellManager, selectionWatcher });
+        // Update the settings when they change.
+        function loadSetting(setting) {
+            model.config = {
+                sendWithShiftEnter: setting.get('sendWithShiftEnter')
+                    .composite,
+                stackMessages: setting.get('stackMessages').composite,
+                unreadNotifications: setting.get('unreadNotifications')
+                    .composite,
+                enableCodeToolbar: setting.get('enableCodeToolbar').composite
+            };
+        }
+        // Init the settings.
+        if (settingRegistry) {
+            // Wait for the application to be restored and for the settings to be loaded.
+            Promise.all([
+                app.restored,
+                settingRegistry.load('jupyter-chat-example:plugin')
+            ])
+                .then(([, setting]) => {
+                // Read the settings
+                loadSetting(setting);
+                // Listen for the plugin setting changes
+                setting.changed.connect(loadSetting);
+            })
+                .catch(reason => {
+                console.error(`Something went wrong when reading the settings.\n${reason}`);
+            });
+        }
+        // Create the attachment opener registry.
+        const attachmentOpenerRegistry = new AttachmentOpenerRegistry();
+        attachmentOpenerRegistry.set('file', (attachment) => {
+            app.commands.execute('docmanager:open', { path: attachment.value });
+        });
+        const panel = buildChatSidebar({
+            model,
+            rmRegistry,
+            themeManager,
+            documentManager: filebrowser === null || filebrowser === void 0 ? void 0 : filebrowser.model.manager,
+            attachmentOpenerRegistry
+        });
+        app.shell.add(panel, 'left');
+    }
+};
+export default [plugin];

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "jupyter-chat-example",
+  "version": "0.8.0",
+  "description": "A chat extension providing a chat as example",
+  "keywords": [
+    "jupyter",
+    "jupyterlab",
+    "jupyterlab-extension"
+  ],
+  "homepage": "https://github.com/jupyterlab/jupyter-chat",
+  "bugs": {
+    "url": "https://github.com/jupyterlab/jupyter-chat/issues"
+  },
+  "license": "BSD-3-Clause",
+  "author": {
+    "name": "Jupyter Development Team",
+    "email": "jupyter@googlegroups.com"
+  },
+  "files": [
+    "lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}",
+    "style/**/*.{css,js,eot,gif,html,jpg,json,png,svg,woff2,ttf}",
+    "src/**/*.{ts,tsx}",
+    "schema/*.json"
+  ],
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "style": "style/index.css",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jupyterlab/jupyter-chat.git"
+  },
+  "scripts": {
+    "build": "jlpm build:lib && jlpm build:labextension:dev",
+    "build:prod": "jlpm clean && jlpm build:lib:prod && jlpm build:labextension",
+    "build:labextension": "jupyter labextension build .",
+    "build:labextension:dev": "jupyter labextension build --development True .",
+    "build:lib": "tsc --sourceMap",
+    "build:lib:prod": "tsc",
+    "clean": "jlpm clean:lib",
+    "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+    "clean:lintcache": "rimraf .eslintcache .stylelintcache",
+    "clean:labextension": "rimraf jupyterlab_chat/labextension jupyterlab_chat/_version.py",
+    "clean:all": "jlpm clean:lib && jlpm clean:labextension && jlpm clean:lintcache",
+    "install:extension": "jlpm build"
+  },
+  "dependencies": {
+    "@jupyter/chat": "^0.8.0",
+    "@jupyterlab/application": "^4.2.0",
+    "@jupyterlab/apputils": "^4.3.0",
+    "@jupyterlab/notebook": "^4.2.0",
+    "@jupyterlab/rendermime": "^4.2.0",
+    "@jupyterlab/settingregistry": "^4.2.0",
+    "@lumino/coreutils": "^2.0.0"
+  },
+  "devDependencies": {
+    "@jupyterlab/builder": "^4.2.0",
+    "@types/json-schema": "^7.0.11",
+    "@types/react": "^18.2.0",
+    "@types/react-addons-linked-state-mixin": "^0.14.22",
+    "css-loader": "^6.7.1",
+    "mkdirp": "^1.0.3",
+    "npm-run-all": "^4.1.5",
+    "rimraf": "^5.0.1",
+    "source-map-loader": "^1.0.2",
+    "style-loader": "^3.3.1",
+    "typescript": "~5.0.2"
+  },
+  "sideEffects": [
+    "style/*.css",
+    "style/index.js"
+  ],
+  "styleModule": "style/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "jupyterlab": {
+    "discovery": {
+      "server": {
+        "managers": [
+          "pip"
+        ],
+        "base": {
+          "name": "jupyter_chat_example"
+        }
+      }
+    },
+    "extension": true,
+    "outputDir": "jupyter_chat_example/labextension",
+    "schemaDir": "schema",
+    "sharedPackages": {
+      "@jupyter/chat": {
+        "bundled": true,
+        "singleton": true
+      }
+    }
+  }
+}

package/schema/plugin.json

@@ -0,0 +1,32 @@
+{
+  "title": "Chat",
+  "description": "Configuration for the chat widgets",
+  "type": "object",
+  "properties": {
+    "sendWithShiftEnter": {
+      "description": "Whether to send a message via Shift-Enter instead of Enter.",
+      "type": "boolean",
+      "default": false,
+      "readOnly": false
+    },
+    "stackMessages": {
+      "description": "Whether to stack consecutive messages from same user.",
+      "type": "boolean",
+      "default": true,
+      "readOnly": false
+    },
+    "unreadNotifications": {
+      "description": "Whether to enable or not the notifications on unread messages.",
+      "type": "boolean",
+      "default": true,
+      "readOnly": false
+    },
+    "enableCodeToolbar": {
+      "description": "Whether to enable or not the code toolbar.",
+      "type": "boolean",
+      "default": true,
+      "readOnly": false
+    }
+  },
+  "additionalProperties": false
+}

package/src/index.ts

@@ -0,0 +1,132 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import {
+  ActiveCellManager,
+  AttachmentOpenerRegistry,
+  buildChatSidebar,
+  ChatModel,
+  IAttachment,
+  IChatMessage,
+  INewMessage,
+  SelectionWatcher
+} from '@jupyter/chat';
+import {
+  JupyterFrontEnd,
+  JupyterFrontEndPlugin
+} from '@jupyterlab/application';
+import { IThemeManager } from '@jupyterlab/apputils';
+import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
+import { INotebookTracker } from '@jupyterlab/notebook';
+import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+import { UUID } from '@lumino/coreutils';
+
+class MyChatModel extends ChatModel {
+  sendMessage(
+    newMessage: INewMessage
+  ): Promise<boolean | void> | boolean | void {
+    const message: IChatMessage = {
+      body: newMessage.body,
+      id: newMessage.id ?? UUID.uuid4(),
+      type: 'msg',
+      time: Date.now() / 1000,
+      sender: { username: 'me' },
+      attachments: this.input.attachments
+    };
+    this.messageAdded(message);
+    this.input.clearAttachments();
+  }
+}
+
+/*
+ * Extension providing a chat panel.
+ */
+const plugin: JupyterFrontEndPlugin<void> = {
+  id: 'jupyter-chat-example:plugin',
+  description: 'The chat panel widget.',
+  autoStart: true,
+  requires: [IRenderMimeRegistry],
+  optional: [
+    IDefaultFileBrowser,
+    INotebookTracker,
+    ISettingRegistry,
+    IThemeManager
+  ],
+  activate: (
+    app: JupyterFrontEnd,
+    rmRegistry: IRenderMimeRegistry,
+    filebrowser: IDefaultFileBrowser | null,
+    notebookTracker: INotebookTracker | null,
+    settingRegistry: ISettingRegistry | null,
+    themeManager: IThemeManager | null
+  ): void => {
+    // Track the current active cell.
+    let activeCellManager: ActiveCellManager | null = null;
+    if (notebookTracker) {
+      activeCellManager = new ActiveCellManager({
+        tracker: notebookTracker,
+        shell: app.shell
+      });
+    }
+
+    // Track the current selection.
+    const selectionWatcher = new SelectionWatcher({
+      shell: app.shell
+    });
+
+    const model = new MyChatModel({ activeCellManager, selectionWatcher });
+
+    // Update the settings when they change.
+    function loadSetting(setting: ISettingRegistry.ISettings): void {
+      model.config = {
+        sendWithShiftEnter: setting.get('sendWithShiftEnter')
+          .composite as boolean,
+        stackMessages: setting.get('stackMessages').composite as boolean,
+        unreadNotifications: setting.get('unreadNotifications')
+          .composite as boolean,
+        enableCodeToolbar: setting.get('enableCodeToolbar').composite as boolean
+      };
+    }
+
+    // Init the settings.
+    if (settingRegistry) {
+      // Wait for the application to be restored and for the settings to be loaded.
+      Promise.all([
+        app.restored,
+        settingRegistry.load('jupyter-chat-example:plugin')
+      ])
+        .then(([, setting]) => {
+          // Read the settings
+          loadSetting(setting);
+
+          // Listen for the plugin setting changes
+          setting.changed.connect(loadSetting);
+        })
+        .catch(reason => {
+          console.error(
+            `Something went wrong when reading the settings.\n${reason}`
+          );
+        });
+    }
+
+    // Create the attachment opener registry.
+    const attachmentOpenerRegistry = new AttachmentOpenerRegistry();
+    attachmentOpenerRegistry.set('file', (attachment: IAttachment) => {
+      app.commands.execute('docmanager:open', { path: attachment.value });
+    });
+
+    const panel = buildChatSidebar({
+      model,
+      rmRegistry,
+      themeManager,
+      documentManager: filebrowser?.model.manager,
+      attachmentOpenerRegistry
+    });
+    app.shell.add(panel, 'left');
+  }
+};
+
+export default [plugin];

package/style/base.css

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+/*
+  See the JupyterLab Developer Guide for useful CSS Patterns:
+
+  https://jupyterlab.readthedocs.io/en/stable/developer/css.html
+*/
+
+@import url('~jupyterlab-chat/style/index.css');

package/style/index.css

@@ -0,0 +1,6 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+@import url('base.css');

package/style/index.js

@@ -0,0 +1,6 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import './base.css';