@jupyter/chat 0.7.0 → 0.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter/chat",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "A package that provides UI components that can be used to create a chat in a Jupyterlab extension.",
   "keywords": [
     "jupyter",
@@ -38,16 +38,7 @@
     "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"
   },
@@ -57,6 +48,8 @@
     "@jupyter/react-components": "^0.15.2",
     "@jupyterlab/application": "^4.2.0",
     "@jupyterlab/apputils": "^4.3.0",
+    "@jupyterlab/docmanager": "^4.2.0",
+    "@jupyterlab/filebrowser": "^4.2.0",
     "@jupyterlab/fileeditor": "^4.2.0",
     "@jupyterlab/notebook": "^4.2.0",
     "@jupyterlab/rendermime": "^4.2.0",
@@ -78,23 +71,12 @@
     "@types/react": "^18.2.0",
     "@types/react-addons-linked-state-mixin": "^0.14.22",
     "@types/react-dom": "^18.2.0",
-    "@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",
     "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"
   },
   "sideEffects": [
@@ -104,98 +86,5 @@
   "styleModule": "style/index.js",
   "publishConfig": {
     "access": "public"
-  },
-  "eslintIgnore": [
-    "node_modules",
-    "dist",
-    "coverage",
-    "**/*.d.ts",
-    "tests",
-    "**/__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/active-cell-manager.ts

@@ -265,9 +265,6 @@ export class ActiveCellManager implements IActiveCellManager {
         this._activeCell?.model.stateChanged.connect(this._cellStateChange);
         this._available = !!this._activeCell && this._notebookVisible;
         this._availabilityChanged.emit(this._available);
-        this._activeCell?.disposed.connect(() => {
-          this._activeCell = null;
-        });
       });
     }
   };

package/src/chat-commands/index.ts

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+export * from './types';
+export * from './registry';

package/src/chat-commands/registry.ts

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import { Token } from '@lumino/coreutils';
+import { ChatCommand, IChatCommandProvider } from './types';
+import { IInputModel } from '../input-model';
+
+/**
+ * Interface of a chat command registry, which tracks a list of chat command
+ * providers. Providers provide a list of commands given a user's partial input,
+ * and define how commands are handled when accepted in the chat commands menu.
+ */
+export interface IChatCommandRegistry {
+  addProvider(provider: IChatCommandProvider): void;
+  getProviders(): IChatCommandProvider[];
+
+  /**
+   * Handles a chat command by calling `handleChatCommand()` on the provider
+   * corresponding to this chat command.
+   */
+  handleChatCommand(command: ChatCommand, inputModel: IInputModel): void;
+}
+
+/**
+ * Default chat command registry implementation.
+ */
+export class ChatCommandRegistry implements IChatCommandRegistry {
+  constructor() {
+    this._providers = new Map<string, IChatCommandProvider>();
+  }
+
+  addProvider(provider: IChatCommandProvider): void {
+    this._providers.set(provider.id, provider);
+  }
+
+  getProviders(): IChatCommandProvider[] {
+    return Array.from(this._providers.values());
+  }
+
+  handleChatCommand(command: ChatCommand, inputModel: IInputModel) {
+    const provider = this._providers.get(command.providerId);
+    if (!provider) {
+      console.error(
+        'Error in handling chat command: No command provider has an ID of ' +
+          command.providerId
+      );
+      return;
+    }
+
+    provider.handleChatCommand(command, inputModel);
+  }
+
+  private _providers: Map<string, IChatCommandProvider>;
+}
+
+export const IChatCommandRegistry = new Token<IChatCommandRegistry>(
+  '@jupyter/chat:IChatCommandRegistry'
+);

package/src/chat-commands/types.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+import { LabIcon } from '@jupyterlab/ui-components';
+import { IInputModel } from '../input-model';
+
+export type ChatCommand = {
+  /**
+   * The name of the command. This defines what the user should type in the
+   * input to have the command appear in the chat commands menu.
+   */
+  name: string;
+
+  /**
+   * ID of the provider the command originated from.
+   */
+  providerId: string;
+
+  /**
+   * If set, this will be rendered as the icon for the command in the chat
+   * commands menu. Jupyter Chat will choose a default if this is unset.
+   */
+  icon?: LabIcon | string;
+
+  /**
+   * If set, this will be rendered as the description for the command in the
+   * chat commands menu. Jupyter Chat will choose a default if this is unset.
+   */
+  description?: string;
+
+  /**
+   * If set, Jupyter Chat will replace the current word with this string after
+   * the command is run from the chat commands menu.
+   *
+   * If all commands from a provider have this property set, then
+   * `handleChatCommands()` can just return on the first line.
+   */
+  replaceWith?: string;
+};
+
+/**
+ * Interface of a command provider.
+ */
+export interface IChatCommandProvider {
+  /**
+   * ID of this command provider.
+   */
+  id: string;
+
+  /**
+   * Async function which accepts the input model and returns a list of
+   * valid chat commands that match the current word. The current word is
+   * space-separated word at the user's cursor.
+   */
+  getChatCommands(inputModel: IInputModel): Promise<ChatCommand[]>;
+
+  /**
+   * Function called when a chat command is run by the user through the chat
+   * commands menu.
+   */
+  handleChatCommand(
+    command: ChatCommand,
+    inputModel: IInputModel
+  ): Promise<void>;
+}

package/src/components/attachments.tsx

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) Jupyter Development Team.
+ * Distributed under the terms of the Modified BSD License.
+ */
+
+// import { IDocumentManager } from '@jupyterlab/docmanager';
+import CloseIcon from '@mui/icons-material/Close';
+import { Box } from '@mui/material';
+import React, { useContext } from 'react';
+
+import { TooltippedButton } from './mui-extras/tooltipped-button';
+import { IAttachment } from '../types';
+import { AttachmentOpenerContext } from '../context';
+
+const ATTACHMENTS_CLASS = 'jp-chat-attachments';
+const ATTACHMENT_CLASS = 'jp-chat-attachment';
+const ATTACHMENT_CLICKABLE_CLASS = 'jp-chat-attachment-clickable';
+const REMOVE_BUTTON_CLASS = 'jp-chat-attachment-remove';
+
+/**
+ * The attachments props.
+ */
+export type AttachmentsProps = {
+  attachments: IAttachment[];
+  onRemove?: (attachment: IAttachment) => void;
+};
+
+/**
+ * The Attachments component.
+ */
+export function AttachmentPreviewList(props: AttachmentsProps): JSX.Element {
+  return (
+    <Box className={ATTACHMENTS_CLASS}>
+      {props.attachments.map(attachment => (
+        <AttachmentPreview {...props} attachment={attachment} />
+      ))}
+    </Box>
+  );
+}
+
+/**
+ * The attachment props.
+ */
+export type AttachmentProps = AttachmentsProps & {
+  attachment: IAttachment;
+};
+
+/**
+ * The Attachment component.
+ */
+export function AttachmentPreview(props: AttachmentProps): JSX.Element {
+  const remove_tooltip = 'Remove attachment';
+  const attachmentOpenerRegistry = useContext(AttachmentOpenerContext);
+
+  return (
+    <Box className={ATTACHMENT_CLASS}>
+      <span
+        className={
+          attachmentOpenerRegistry?.get(props.attachment.type)
+            ? ATTACHMENT_CLICKABLE_CLASS
+            : ''
+        }
+        onClick={() =>
+          attachmentOpenerRegistry?.get(props.attachment.type)?.(
+            props.attachment
+          )
+        }
+      >
+        {props.attachment.value}
+      </span>
+      {props.onRemove && (
+        <TooltippedButton
+          onClick={() => props.onRemove!(props.attachment)}
+          tooltip={remove_tooltip}
+          buttonProps={{
+            size: 'small',
+            title: remove_tooltip,
+            className: REMOVE_BUTTON_CLASS
+          }}
+          sx={{
+            minWidth: 'unset',
+            padding: '0',
+            color: 'inherit'
+          }}
+        >
+          <CloseIcon />
+        </TooltippedButton>
+      )}
+    </Box>
+  );
+}