jupyterlab-chat 0.6.0

package/lib/ychat.js

@@ -0,0 +1,148 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+import { YDocument } from '@jupyter/ydoc';
+import { JSONExt } from '@lumino/coreutils';
+/**
+ * The jupyterlab chat shared document.
+ */
+export class YChat extends YDocument {
+    /**
+     * Create a new jupyterlab chat model.
+     */
+    constructor(options) {
+        super(options);
+        /**
+         * Document version
+         */
+        this.version = '1.0.0';
+        this._usersObserver = (event) => {
+            const userChange = new Array();
+            event.keysChanged.forEach(key => {
+                const change = event.changes.keys.get(key);
+                if (change) {
+                    switch (change.action) {
+                        case 'add':
+                            userChange.push({
+                                key,
+                                newValue: this._users.get(key),
+                                type: 'add'
+                            });
+                            break;
+                        case 'delete':
+                            userChange.push({
+                                key,
+                                oldValue: change.oldValue,
+                                type: 'remove'
+                            });
+                            break;
+                        case 'update':
+                            userChange.push({
+                                key: key,
+                                oldValue: change.oldValue,
+                                newValue: this._users.get(key),
+                                type: 'change'
+                            });
+                            break;
+                    }
+                }
+            });
+            this._changed.emit({ userChange: userChange });
+        };
+        this._messagesObserver = (event) => {
+            const messageChanges = event.delta;
+            this._changed.emit({
+                messageChanges: messageChanges
+            });
+        };
+        this._metadataObserver = (event) => {
+            const metadataChange = new Array();
+            event.changes.keys.forEach((change, key) => {
+                switch (change.action) {
+                    case 'add':
+                        metadataChange.push({
+                            key,
+                            newValue: this._metadata.get(key),
+                            type: 'add'
+                        });
+                        break;
+                    case 'delete':
+                        metadataChange.push({
+                            key,
+                            oldValue: change.oldValue,
+                            type: 'remove'
+                        });
+                        break;
+                    case 'update':
+                        metadataChange.push({
+                            key: key,
+                            oldValue: change.oldValue,
+                            newValue: this._metadata.get(key),
+                            type: 'change'
+                        });
+                        break;
+                }
+            });
+            this._changed.emit({
+                metadataChanges: metadataChange
+            });
+        };
+        this._users = this.ydoc.getMap('users');
+        this._users.observe(this._usersObserver);
+        this._messages = this.ydoc.getArray('messages');
+        this._messages.observe(this._messagesObserver);
+        this._metadata = this.ydoc.getMap('metadata');
+        this._metadata.observe(this._metadataObserver);
+    }
+    /**
+     * Static method to create instances on the sharedModel
+     *
+     * @returns The sharedModel instance
+     */
+    static create(options) {
+        return new YChat(options);
+    }
+    get id() {
+        return this._metadata.get('id') || '';
+    }
+    get users() {
+        return JSONExt.deepCopy(this._users.toJSON());
+    }
+    get messages() {
+        return JSONExt.deepCopy(this._messages.toJSON());
+    }
+    getUser(username) {
+        if (!username) {
+            return undefined;
+        }
+        return this._users.get(username);
+    }
+    setUser(value) {
+        this.transact(() => {
+            this._users.set(value.username, value);
+        });
+    }
+    getMessage(index) {
+        return this._messages.get(index);
+    }
+    addMessage(value) {
+        this.transact(() => {
+            this._messages.push([value]);
+        });
+    }
+    updateMessage(index, value) {
+        this.transact(() => {
+            this._messages.delete(index);
+            this._messages.insert(index, [value]);
+        });
+    }
+    getMessageIndex(id) {
+        return this._messages.toArray().findIndex(msg => msg.id === id);
+    }
+    deleteMessage(index) {
+        this.transact(() => {
+            this._messages.delete(index);
+        });
+    }
+}

package/package.json

@@ -0,0 +1,205 @@
+{
+  "name": "jupyterlab-chat",
+  "version": "0.6.0",
+  "description": "The library to build a chat based on shared document",
+  "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}"
+  ],
+  "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",
+    "build:prod": "jlpm clean && jlpm build:lib:prod",
+    "build:lib": "tsc --sourceMap",
+    "build:lib:prod": "tsc",
+    "clean": "jlpm clean:lib",
+    "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+    "clean:lintcache": "rimraf .eslintcache .stylelintcache",
+    "clean:all": "jlpm clean:lib && jlpm clean:lintcache",
+    "eslint": "jlpm eslint:check --fix",
+    "eslint:check": "eslint . --cache --ext .ts,.tsx",
+    "install:extension": "jlpm build",
+    "lint": "jlpm stylelint && jlpm prettier && jlpm eslint",
+    "lint:check": "jlpm stylelint:check && jlpm prettier:check && jlpm eslint:check",
+    "prettier": "jlpm prettier:base --write --list-different",
+    "prettier:base": "prettier \"**/*{.ts,.tsx,.js,.jsx,.css,.json,.md}\"",
+    "prettier:check": "jlpm prettier:base --check",
+    "stylelint": "jlpm stylelint:check --fix",
+    "stylelint:check": "stylelint --cache \"style/**/*.css\"",
+    "test": "jest --coverage",
+    "watch:src": "tsc -w --sourceMap"
+  },
+  "dependencies": {
+    "@jupyter/chat": "^0.6.0",
+    "@jupyter/docprovider": "^2.1.4",
+    "@jupyter/ydoc": "^1.1.1",
+    "@jupyterlab/application": "^4.2.0",
+    "@jupyterlab/apputils": "^4.3.0",
+    "@jupyterlab/coreutils": "^6.2.0",
+    "@jupyterlab/docregistry": "^4.2.0",
+    "@jupyterlab/launcher": "^4.2.0",
+    "@jupyterlab/notebook": "^4.2.0",
+    "@jupyterlab/rendermime": "^4.2.0",
+    "@jupyterlab/services": "^7.2.0",
+    "@jupyterlab/settingregistry": "^4.2.0",
+    "@jupyterlab/translation": "^4.2.0",
+    "@jupyterlab/ui-components": "^4.2.0",
+    "@lumino/commands": "^2.0.0",
+    "@lumino/coreutils": "^2.0.0",
+    "@lumino/signaling": "^2.0.0",
+    "@lumino/widgets": "^2.0.0",
+    "react": "^18.2.0",
+    "y-protocols": "^1.0.5",
+    "yjs": "^13.5.40"
+  },
+  "devDependencies": {
+    "@jupyterlab/testing": "^4.2.0",
+    "@types/jest": "^29.2.0",
+    "@types/json-schema": "^7.0.11",
+    "@types/react": "^18.2.0",
+    "@types/react-addons-linked-state-mixin": "^0.14.22",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
+    "css-loader": "^6.7.1",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "jest": "^29.2.0",
+    "mkdirp": "^1.0.3",
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.0.0",
+    "rimraf": "^5.0.1",
+    "source-map-loader": "^1.0.2",
+    "style-loader": "^3.3.1",
+    "stylelint": "^15.10.1",
+    "stylelint-config-recommended": "^13.0.0",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-csstree-validator": "^3.0.0",
+    "stylelint-prettier": "^4.0.0",
+    "typescript": "~5.0.2",
+    "yjs": "^13.5.0"
+  },
+  "sideEffects": [
+    "style/*.css",
+    "style/index.js"
+  ],
+  "styleModule": "style/index.js",
+  "publishConfig": {
+    "access": "public"
+  },
+  "eslintIgnore": [
+    "node_modules",
+    "dist",
+    "coverage",
+    "**/*.d.ts",
+    "tests",
+    "**/__tests__",
+    "ui-tests"
+  ],
+  "eslintConfig": {
+    "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "plugin:prettier/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+      "project": "tsconfig.json",
+      "sourceType": "module"
+    },
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "rules": {
+      "@typescript-eslint/naming-convention": [
+        "error",
+        {
+          "selector": "interface",
+          "format": [
+            "PascalCase"
+          ],
+          "custom": {
+            "regex": "^I[A-Z]",
+            "match": true
+          }
+        }
+      ],
+      "@typescript-eslint/no-unused-vars": [
+        "warn",
+        {
+          "args": "none"
+        }
+      ],
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-namespace": "off",
+      "@typescript-eslint/no-use-before-define": "off",
+      "@typescript-eslint/quotes": [
+        "error",
+        "single",
+        {
+          "avoidEscape": true,
+          "allowTemplateLiterals": false
+        }
+      ],
+      "curly": [
+        "error",
+        "all"
+      ],
+      "eqeqeq": "error",
+      "prefer-arrow-callback": "error"
+    }
+  },
+  "prettier": {
+    "singleQuote": true,
+    "trailingComma": "none",
+    "arrowParens": "avoid",
+    "endOfLine": "auto",
+    "overrides": [
+      {
+        "files": "package.json",
+        "options": {
+          "tabWidth": 2
+        }
+      }
+    ]
+  },
+  "stylelint": {
+    "extends": [
+      "stylelint-config-recommended",
+      "stylelint-config-standard",
+      "stylelint-prettier/recommended"
+    ],
+    "plugins": [
+      "stylelint-csstree-validator"
+    ],
+    "rules": {
+      "csstree/validator": true,
+      "property-no-vendor-prefix": null,
+      "selector-class-pattern": "^([a-z][A-z\\d]*)(-[A-z\\d]+)*$",
+      "selector-no-vendor-prefix": null,
+      "value-no-vendor-prefix": null
+    }
+  }
+}

package/src/__tests__/jupyterlab_collaborative_chat.spec.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+/**
+ * Example of [Jest](https://jestjs.io/docs/getting-started) unit tests
+ */
+
+describe('jupyterlab-chat', () => {
+  it('should be tested', () => {
+    expect(1 + 1).toEqual(2);
+  });
+});

package/src/factory.ts

@@ -0,0 +1,207 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import {
+  ChatWidget,
+  IActiveCellManager,
+  IAutocompletionRegistry,
+  ISelectionWatcher
+} from '@jupyter/chat';
+import { IThemeManager } from '@jupyterlab/apputils';
+import { ABCWidgetFactory, DocumentRegistry } from '@jupyterlab/docregistry';
+import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
+import { Contents, User } from '@jupyterlab/services';
+import { CommandRegistry } from '@lumino/commands';
+import { ISignal, Signal } from '@lumino/signaling';
+
+import { LabChatModel } from './model';
+import { LabChatPanel } from './widget';
+import { YChat } from './ychat';
+import { ILabChatConfig, IWidgetConfig } from './token';
+
+/**
+ * The object provided by the chatDocument extension.
+ * It is used to set the current config (from settings) to newly created chat widget,
+ * and to propagate every changes to the existing chat widgets.
+ */
+export class WidgetConfig implements IWidgetConfig {
+  /**
+   * The constructor of the WidgetConfig.
+   */
+  constructor(config: Partial<ILabChatConfig>) {
+    this._config = config;
+  }
+
+  /**
+   * Getter and setter for the config.
+   */
+  get config(): Partial<ILabChatConfig> {
+    return this._config;
+  }
+  set config(value: Partial<ILabChatConfig>) {
+    this._config = { ...this._config, ...value };
+    this._configChanged.emit(value);
+  }
+
+  /**
+   * Getter for the configChanged signal
+   */
+  get configChanged(): ISignal<WidgetConfig, Partial<ILabChatConfig>> {
+    return this._configChanged;
+  }
+
+  private _config: Partial<ILabChatConfig>;
+  private _configChanged = new Signal<WidgetConfig, Partial<ILabChatConfig>>(
+    this
+  );
+}
+
+/**
+ * A widget factory to create new instances of LabChatWidget.
+ */
+export class ChatWidgetFactory extends ABCWidgetFactory<
+  LabChatPanel,
+  LabChatModel
+> {
+  /**
+   * Constructor of ChatWidgetFactory.
+   *
+   * @param options Constructor options
+   */
+  constructor(options: ChatWidgetFactory.IOptions<LabChatPanel>) {
+    super(options);
+    this._themeManager = options.themeManager;
+    this._rmRegistry = options.rmRegistry;
+    this._autocompletionRegistry = options.autocompletionRegistry;
+  }
+
+  /**
+   * Create a new widget given a context.
+   *
+   * @param context Contains the information of the file
+   * @returns The widget
+   */
+  protected createNewWidget(context: ChatWidgetFactory.IContext): LabChatPanel {
+    context.rmRegistry = this._rmRegistry;
+    context.themeManager = this._themeManager;
+    context.autocompletionRegistry = this._autocompletionRegistry;
+    return new LabChatPanel({
+      context,
+      content: new ChatWidget(context)
+    });
+  }
+
+  private _themeManager: IThemeManager | null;
+  private _rmRegistry: IRenderMimeRegistry;
+  private _autocompletionRegistry?: IAutocompletionRegistry;
+}
+
+export namespace ChatWidgetFactory {
+  export interface IContext extends DocumentRegistry.IContext<LabChatModel> {
+    themeManager: IThemeManager | null;
+    rmRegistry: IRenderMimeRegistry;
+    autocompletionRegistry?: IAutocompletionRegistry;
+  }
+
+  export interface IOptions<T extends LabChatPanel>
+    extends DocumentRegistry.IWidgetFactoryOptions<T> {
+    themeManager: IThemeManager | null;
+    rmRegistry: IRenderMimeRegistry;
+    autocompletionRegistry?: IAutocompletionRegistry;
+  }
+}
+
+export class LabChatModelFactory
+  implements DocumentRegistry.IModelFactory<LabChatModel>
+{
+  constructor(options: LabChatModel.IOptions) {
+    this._user = options.user;
+    this._widgetConfig = options.widgetConfig;
+    this._commands = options.commands;
+    this._activeCellManager = options.activeCellManager ?? null;
+    this._selectionWatcher = options.selectionWatcher ?? null;
+  }
+
+  collaborative = true;
+  /**
+   * The name of the model.
+   *
+   * @returns The name
+   */
+  get name(): string {
+    return 'chat';
+  }
+
+  /**
+   * The content type of the file.
+   *
+   * @returns The content type
+   */
+  get contentType(): Contents.ContentType {
+    return 'chat';
+  }
+
+  /**
+   * The format of the file.
+   *
+   * @returns the file format
+   */
+  get fileFormat(): Contents.FileFormat {
+    return 'text';
+  }
+
+  /**
+   * Get whether the model factory has been disposed.
+   *
+   * @returns disposed status
+   */
+
+  get isDisposed(): boolean {
+    return this._disposed;
+  }
+
+  /**
+   * Dispose the model factory.
+   */
+  dispose(): void {
+    this._disposed = true;
+  }
+
+  /**
+   * Get the preferred language given the path on the file.
+   *
+   * @param path path of the file represented by this document model
+   * @returns The preferred language
+   */
+  preferredLanguage(path: string): string {
+    return '';
+  }
+
+  /**
+   * Create a new instance of LabChatModel.
+   *
+   * @param languagePreference Language
+   * @param modelDB Model database
+   * @returns The model
+   */
+
+  createNew(options: DocumentRegistry.IModelOptions<YChat>): LabChatModel {
+    return new LabChatModel({
+      ...options,
+      user: this._user,
+      widgetConfig: this._widgetConfig,
+      commands: this._commands,
+      activeCellManager: this._activeCellManager,
+      selectionWatcher: this._selectionWatcher
+    });
+  }
+
+  private _disposed = false;
+  private _user: User.IIdentity | null;
+  private _widgetConfig: IWidgetConfig;
+  private _commands?: CommandRegistry;
+  private _activeCellManager: IActiveCellManager | null;
+  private _selectionWatcher: ISelectionWatcher | null;
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+export * from './factory';
+export * from './model';
+export * from './token';
+export * from './widget';
+export * from './ychat';