Split the project in two packages, one for jupyter-chat UI and one as…

… a jupyterlab extension

lerna.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
+  "useWorkspaces": true,
+  "version": "0.1.0",
+  "npmClient": "yarn",
+  "useNx": true
+}

package.json

@@ -1,7 +1,8 @@
 {
-    "name": "@jupyter/chat",
+    "name": "@jupyter/chat-root",
     "version": "0.1.0",
-    "description": "A chat extension for Jupyterlab",
+    "description": "A chat package for Jupyterlab extension",
+    "private": true,
     "keywords": [
         "jupyter",
         "jupyterlab",
@@ -16,108 +17,30 @@
         "name": "Jupyter Development Team",
         "email": "[email protected]"
     },
-    "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/QuantStack/jupyter-chat.git"
     },
+    "workspaces": [
+        "packages/*"
+    ],
     "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": {
-        "@emotion/react": "^11.10.5",
-        "@emotion/styled": "^11.10.5",
-        "@jupyterlab/apputils": "^4.0.5",
-        "@jupyterlab/coreutils": "^6.0.5",
-        "@jupyterlab/fileeditor": "^4.0.5",
-        "@jupyterlab/rendermime": "^4.0.5",
-        "@jupyterlab/services": "^7.0.5",
-        "@jupyterlab/ui-components": "^4.0.5",
-        "@lumino/coreutils": "^2.1.2",
-        "@lumino/disposable": "^2.1.2",
-        "@lumino/signaling": "^2.1.2",
-        "@mui/icons-material": "^5.11.0",
-        "@mui/material": "^5.11.0",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0"
+        "build": "lerna run build --stream",
+        "build:core": "lerna run build --stream --scope \"@jupyter-ai/core\"",
+        "build:prod": "lerna run build:prod --stream",
+        "clean": "lerna run clean",
+        "clean:all": "lerna run clean:all",
+        "dev": "jupyter lab --config playground/config.py",
+        "dev-install": "lerna run dev-install --stream",
+        "dev-uninstall": "lerna run dev-uninstall --stream",
+        "install-from-src": "lerna run install-from-src --stream",
+        "lint": "jlpm && lerna run prettier && lerna run eslint",
+        "lint:check": "lerna run prettier:check && lerna run eslint:check",
+        "watch": "lerna run watch --parallel --stream",
+        "test": "lerna run test"
     },
     "devDependencies": {
-        "@jupyterlab/builder": "^4.0.0",
-        "@jupyterlab/testutils": "^4.0.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",
-        "@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",
-        "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"
-    },
-    "jupyterlab": {
-        "discovery": {
-            "server": {
-                "managers": [
-                    "pip"
-                ],
-                "base": {
-                    "name": "jupyter_chat"
-                }
-            }
-        },
-        "extension": false,
-        "schemaDir": "schema"
+        "lerna": "^6.4.1"
     },
     "eslintIgnore": [
         "node_modules",

packages/jupyter-chat-extension/.gitignore

@@ -0,0 +1,125 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyter_chat_extension/labextension
+# Version file is handled by hatchling
+jupyter_chat_extension/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/

packages/jupyter-chat-extension/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Jupyter Development Team
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

packages/jupyter-chat-extension/README.md

@@ -0,0 +1,95 @@
+# jupyter_chat_extension
+
+[![Github Actions Status](https://github.com/QuantStack/jupyter-chat/workflows/Build/badge.svg)](https://github.com/QuantStack/jupyter-chat/actions/workflows/build.yml)
+
+A chat extension for Jupyterlab
+
+This package is composed of a Python package named `jupyter_chat_extension`
+for the server side and a NPM package named `@jupyter/chat-extension`
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the package, execute:
+
+```bash
+pip install jupyter_chat_extension
+```
+
+## Uninstall
+
+To remove the package, execute:
+
+```bash
+pip uninstall jupyter_chat_extension
+```
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyter-chat/jupyter-chat-extension directory
+# Install package in development mode
+pip install -e ".[test]"
+# Rebuild Typescript source after making changes
+jlpm build
+```
+
+By default, the `jlpm build` command generates the source maps for this package to make it easier to debug using the browser dev tools.
+
+### Development uninstall
+
+```bash
+pip uninstall jupyter_chat_extension
+```
+
+### Testing the package
+
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jupyter_chat_extension
+```
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)