Skip to content

Commit

Permalink
Restore @jupyterlab/shared-models as proxy to @jupyter/ydoc (#14133)
Browse files Browse the repository at this point in the history
* Restore @jupyterlab/shared-models as proxy to @jupyter/ydoc

* Fix build of the app

* Add dependency to @jupyterlab/nbformat
  • Loading branch information
fcollonval committed Mar 17, 2023
1 parent 36f65af commit 45bd507
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 0 deletions.
1 change: 1 addition & 0 deletions buildutils/src/ensure-repo.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ const UNUSED: Dict<string[]> = {
'@jupyterlab/coreutils': ['path-browserify'],
'@jupyterlab/galata': ['node-fetch', 'http-server'],
'@jupyterlab/services': ['node-fetch', 'ws'],
'@jupyterlab/shared-models': ['@jupyter/ydoc', '@jupyterlab/nbformat'],
'@jupyterlab/rendermime': ['@jupyterlab/mathjax2'],
'@jupyterlab/testutils': [
'node-fetch',
Expand Down
2 changes: 2 additions & 0 deletions dev_mode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@
"@jupyterlab/settingeditor": "~3.6.1",
"@jupyterlab/settingeditor-extension": "~3.6.1",
"@jupyterlab/settingregistry": "~3.6.1",
"@jupyterlab/shared-models": "~3.6.1",
"@jupyterlab/shortcuts-extension": "~3.6.1",
"@jupyterlab/statedb": "~3.6.1",
"@jupyterlab/statusbar": "~3.6.1",
Expand Down Expand Up @@ -391,6 +392,7 @@
"@jupyterlab/settingeditor": "../packages/settingeditor",
"@jupyterlab/settingeditor-extension": "../packages/settingeditor-extension",
"@jupyterlab/settingregistry": "../packages/settingregistry",
"@jupyterlab/shared-models": "../packages/shared-models",
"@jupyterlab/shortcuts-extension": "../packages/shortcuts-extension",
"@jupyterlab/statedb": "../packages/statedb",
"@jupyterlab/statusbar": "../packages/statusbar",
Expand Down
1 change: 1 addition & 0 deletions packages/metapackage/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@
"@jupyterlab/settingeditor": "^3.6.1",
"@jupyterlab/settingeditor-extension": "^3.6.1",
"@jupyterlab/settingregistry": "^3.6.1",
"@jupyterlab/shared-models": "^3.6.1",
"@jupyterlab/shortcuts-extension": "^3.6.1",
"@jupyterlab/statedb": "^3.6.1",
"@jupyterlab/statusbar": "^3.6.1",
Expand Down
3 changes: 3 additions & 0 deletions packages/metapackage/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,9 @@
{
"path": "../settingregistry"
},
{
"path": "../shared-models"
},
{
"path": "../shortcuts-extension"
},
Expand Down
1 change: 1 addition & 0 deletions packages/shared-models/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require('@jupyterlab/testutils/lib/babel.config');
2 changes: 2 additions & 0 deletions packages/shared-models/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
const func = require('@jupyterlab/testutils/lib/jest-config');
module.exports = func(__dirname);
40 changes: 40 additions & 0 deletions packages/shared-models/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"name": "@jupyterlab/shared-models",
"version": "3.6.1",
"description": "JupyterLab - Shared Models",
"homepage": "https://github.com/jupyterlab/jupyterlab",
"bugs": {
"url": "https://github.com/jupyterlab/jupyterlab/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/jupyterlab/jupyterlab.git"
},
"license": "BSD-3-Clause",
"author": "Project Jupyter",
"main": "lib/index.js",
"types": "lib/index.d.ts",
"directories": {
"lib": "lib/"
},
"files": [
"lib/**/*.{d.ts,eot,gif,html,jpg,js,js.map,json,png,svg,woff2,ttf}"
],
"scripts": {
"build": "tsc -b",
"clean": "rimraf lib tsconfig.tsbuildinfo",
"docs": "typedoc src --tsconfig typedoc-tsconfig.json",
"watch": "tsc -b --watch"
},
"dependencies": {
"@jupyter/ydoc": "~0.2.0",
"@jupyterlab/nbformat": "^3.6.1"
},
"devDependencies": {
"rimraf": "~3.0.0",
"typescript": "~4.1.3"
},
"publishConfig": {
"access": "public"
}
}
13 changes: 13 additions & 0 deletions packages/shared-models/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/* -----------------------------------------------------------------------------
| Copyright (c) Jupyter Development Team.
| Distributed under the terms of the Modified BSD License.
|----------------------------------------------------------------------------*/
/**
* @packageDocumentation
* @module shared-models
*/

/**
* @deprecated This package will be removed in JupyterLab 4. Please use @jupyter/ydoc directly
*/
export * from '@jupyter/ydoc';
13 changes: 13 additions & 0 deletions packages/shared-models/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"extends": "../../tsconfigbase",
"compilerOptions": {
"outDir": "lib",
"rootDir": "src"
},
"include": ["src/*"],
"references": [
{
"path": "../nbformat"
}
]
}
6 changes: 6 additions & 0 deletions packages/shared-models/typedoc-tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"composite": false
}
}
4 changes: 4 additions & 0 deletions packages/shared-models/typedoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"out": "../../docs/api/shared-models",
"theme": "../../typedoc-theme"
}
3 changes: 3 additions & 0 deletions tsconfigdoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,9 @@
{
"path": "./packages/settingregistry"
},
{
"path": "./packages/shared-models"
},
{
"path": "./packages/shortcuts-extension"
},
Expand Down

0 comments on commit 45bd507

Please sign in to comment.