@jupyterlab/application 0.19.1-alpha.0 → 0.19.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +34 -0
- package/lib/index.d.ts +241 -241
- package/lib/index.js +283 -283
- package/lib/layoutrestorer.d.ts +205 -205
- package/lib/layoutrestorer.js +423 -423
- package/lib/mimerenderers.d.ts +22 -22
- package/lib/mimerenderers.js +137 -134
- package/lib/router.d.ts +204 -204
- package/lib/router.js +145 -145
- package/lib/shell.d.ts +277 -277
- package/lib/shell.js +857 -854
- package/package.json +13 -10
package/lib/mimerenderers.d.ts
CHANGED
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
import { IInstanceTracker, InstanceTracker } from '@jupyterlab/apputils';
|
|
2
|
-
import { MimeDocument } from '@jupyterlab/docregistry';
|
|
3
|
-
import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
|
|
4
|
-
import { Token } from '@phosphor/coreutils';
|
|
5
|
-
import { JupyterLabPlugin } from './index';
|
|
6
|
-
/**
|
|
7
|
-
* A class that tracks mime documents.
|
|
8
|
-
*/
|
|
9
|
-
export interface IMimeDocumentTracker extends IInstanceTracker<MimeDocument> {
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* The mime document tracker token.
|
|
13
|
-
*/
|
|
14
|
-
export declare const IMimeDocumentTracker: Token<IMimeDocumentTracker>;
|
|
15
|
-
/**
|
|
16
|
-
* Create rendermime plugins for rendermime extension modules.
|
|
17
|
-
*/
|
|
18
|
-
export declare function createRendermimePlugins(extensions: IRenderMime.IExtensionModule[]): JupyterLabPlugin<void | IMimeDocumentTracker>[];
|
|
19
|
-
/**
|
|
20
|
-
* Create rendermime plugins for rendermime extension modules.
|
|
21
|
-
*/
|
|
22
|
-
export declare function createRendermimePlugin(tracker: InstanceTracker<MimeDocument>, item: IRenderMime.IExtension): JupyterLabPlugin<void>;
|
|
1
|
+
import { IInstanceTracker, InstanceTracker } from '@jupyterlab/apputils';
|
|
2
|
+
import { MimeDocument } from '@jupyterlab/docregistry';
|
|
3
|
+
import { IRenderMime } from '@jupyterlab/rendermime-interfaces';
|
|
4
|
+
import { Token } from '@phosphor/coreutils';
|
|
5
|
+
import { JupyterLabPlugin } from './index';
|
|
6
|
+
/**
|
|
7
|
+
* A class that tracks mime documents.
|
|
8
|
+
*/
|
|
9
|
+
export interface IMimeDocumentTracker extends IInstanceTracker<MimeDocument> {
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* The mime document tracker token.
|
|
13
|
+
*/
|
|
14
|
+
export declare const IMimeDocumentTracker: Token<IMimeDocumentTracker>;
|
|
15
|
+
/**
|
|
16
|
+
* Create rendermime plugins for rendermime extension modules.
|
|
17
|
+
*/
|
|
18
|
+
export declare function createRendermimePlugins(extensions: IRenderMime.IExtensionModule[]): JupyterLabPlugin<void | IMimeDocumentTracker>[];
|
|
19
|
+
/**
|
|
20
|
+
* Create rendermime plugins for rendermime extension modules.
|
|
21
|
+
*/
|
|
22
|
+
export declare function createRendermimePlugin(tracker: InstanceTracker<MimeDocument>, item: IRenderMime.IExtension): JupyterLabPlugin<void>;
|
package/lib/mimerenderers.js
CHANGED
|
@@ -1,134 +1,137 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
// Copyright (c) Jupyter Development Team.
|
|
3
|
-
// Distributed under the terms of the Modified BSD License.
|
|
4
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
-
const apputils_1 = require("@jupyterlab/apputils");
|
|
6
|
-
const docregistry_1 = require("@jupyterlab/docregistry");
|
|
7
|
-
const rendermime_1 = require("@jupyterlab/rendermime");
|
|
8
|
-
const coreutils_1 = require("@phosphor/coreutils");
|
|
9
|
-
const properties_1 = require("@phosphor/properties");
|
|
10
|
-
const layoutrestorer_1 = require("./layoutrestorer");
|
|
11
|
-
/* tslint:disable */
|
|
12
|
-
/**
|
|
13
|
-
* The mime document tracker token.
|
|
14
|
-
*/
|
|
15
|
-
exports.IMimeDocumentTracker = new coreutils_1.Token('@jupyterlab/application:IMimeDocumentTracker');
|
|
16
|
-
/* tslint:enable */
|
|
17
|
-
/**
|
|
18
|
-
* Create rendermime plugins for rendermime extension modules.
|
|
19
|
-
*/
|
|
20
|
-
function createRendermimePlugins(extensions) {
|
|
21
|
-
const plugins = [];
|
|
22
|
-
const namespace = 'application-mimedocuments';
|
|
23
|
-
const tracker = new apputils_1.InstanceTracker({ namespace });
|
|
24
|
-
extensions.forEach(mod => {
|
|
25
|
-
let data = mod.default;
|
|
26
|
-
// Handle CommonJS exports.
|
|
27
|
-
if (!mod.hasOwnProperty('__esModule')) {
|
|
28
|
-
data = mod;
|
|
29
|
-
}
|
|
30
|
-
if (!Array.isArray(data)) {
|
|
31
|
-
data = [data];
|
|
32
|
-
}
|
|
33
|
-
data.forEach(item => {
|
|
34
|
-
plugins.push(createRendermimePlugin(tracker, item));
|
|
35
|
-
});
|
|
36
|
-
});
|
|
37
|
-
// Also add a meta-plugin handling state restoration
|
|
38
|
-
// and exposing the mime document instance tracker.
|
|
39
|
-
plugins.push({
|
|
40
|
-
id: '@jupyterlab/application:mimedocument',
|
|
41
|
-
requires: [layoutrestorer_1.ILayoutRestorer],
|
|
42
|
-
provides: exports.IMimeDocumentTracker,
|
|
43
|
-
autoStart: true,
|
|
44
|
-
activate: (app, restorer) => {
|
|
45
|
-
restorer.restore(tracker, {
|
|
46
|
-
command: 'docmanager:open',
|
|
47
|
-
args: widget => ({
|
|
48
|
-
path: widget.context.path,
|
|
49
|
-
factory: Private.factoryNameProperty.get(widget)
|
|
50
|
-
}),
|
|
51
|
-
name: widget => `${widget.context.path}:${Private.factoryNameProperty.get(widget)}`
|
|
52
|
-
});
|
|
53
|
-
return tracker;
|
|
54
|
-
}
|
|
55
|
-
});
|
|
56
|
-
return plugins;
|
|
57
|
-
}
|
|
58
|
-
exports.createRendermimePlugins = createRendermimePlugins;
|
|
59
|
-
/**
|
|
60
|
-
* Create rendermime plugins for rendermime extension modules.
|
|
61
|
-
*/
|
|
62
|
-
function createRendermimePlugin(tracker, item) {
|
|
63
|
-
return {
|
|
64
|
-
id: item.id,
|
|
65
|
-
requires: [layoutrestorer_1.ILayoutRestorer, rendermime_1.IRenderMimeRegistry],
|
|
66
|
-
autoStart: true,
|
|
67
|
-
activate: (app, restorer, rendermime) => {
|
|
68
|
-
// Add the mime renderer.
|
|
69
|
-
if (item.rank !== undefined) {
|
|
70
|
-
rendermime.addFactory(item.rendererFactory, item.rank);
|
|
71
|
-
}
|
|
72
|
-
else {
|
|
73
|
-
rendermime.addFactory(item.rendererFactory);
|
|
74
|
-
}
|
|
75
|
-
// Handle the widget factory.
|
|
76
|
-
if (!item.documentWidgetFactoryOptions) {
|
|
77
|
-
return;
|
|
78
|
-
}
|
|
79
|
-
let registry = app.docRegistry;
|
|
80
|
-
let options = [];
|
|
81
|
-
if (Array.isArray(item.documentWidgetFactoryOptions)) {
|
|
82
|
-
options = item.documentWidgetFactoryOptions;
|
|
83
|
-
}
|
|
84
|
-
else {
|
|
85
|
-
options = [
|
|
86
|
-
item.documentWidgetFactoryOptions
|
|
87
|
-
];
|
|
88
|
-
}
|
|
89
|
-
if (item.fileTypes) {
|
|
90
|
-
item.fileTypes.forEach(ft => {
|
|
91
|
-
app.docRegistry.addFileType(ft);
|
|
92
|
-
});
|
|
93
|
-
}
|
|
94
|
-
options.forEach(option => {
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
1
|
+
"use strict";
|
|
2
|
+
// Copyright (c) Jupyter Development Team.
|
|
3
|
+
// Distributed under the terms of the Modified BSD License.
|
|
4
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
const apputils_1 = require("@jupyterlab/apputils");
|
|
6
|
+
const docregistry_1 = require("@jupyterlab/docregistry");
|
|
7
|
+
const rendermime_1 = require("@jupyterlab/rendermime");
|
|
8
|
+
const coreutils_1 = require("@phosphor/coreutils");
|
|
9
|
+
const properties_1 = require("@phosphor/properties");
|
|
10
|
+
const layoutrestorer_1 = require("./layoutrestorer");
|
|
11
|
+
/* tslint:disable */
|
|
12
|
+
/**
|
|
13
|
+
* The mime document tracker token.
|
|
14
|
+
*/
|
|
15
|
+
exports.IMimeDocumentTracker = new coreutils_1.Token('@jupyterlab/application:IMimeDocumentTracker');
|
|
16
|
+
/* tslint:enable */
|
|
17
|
+
/**
|
|
18
|
+
* Create rendermime plugins for rendermime extension modules.
|
|
19
|
+
*/
|
|
20
|
+
function createRendermimePlugins(extensions) {
|
|
21
|
+
const plugins = [];
|
|
22
|
+
const namespace = 'application-mimedocuments';
|
|
23
|
+
const tracker = new apputils_1.InstanceTracker({ namespace });
|
|
24
|
+
extensions.forEach(mod => {
|
|
25
|
+
let data = mod.default;
|
|
26
|
+
// Handle CommonJS exports.
|
|
27
|
+
if (!mod.hasOwnProperty('__esModule')) {
|
|
28
|
+
data = mod;
|
|
29
|
+
}
|
|
30
|
+
if (!Array.isArray(data)) {
|
|
31
|
+
data = [data];
|
|
32
|
+
}
|
|
33
|
+
data.forEach(item => {
|
|
34
|
+
plugins.push(createRendermimePlugin(tracker, item));
|
|
35
|
+
});
|
|
36
|
+
});
|
|
37
|
+
// Also add a meta-plugin handling state restoration
|
|
38
|
+
// and exposing the mime document instance tracker.
|
|
39
|
+
plugins.push({
|
|
40
|
+
id: '@jupyterlab/application:mimedocument',
|
|
41
|
+
requires: [layoutrestorer_1.ILayoutRestorer],
|
|
42
|
+
provides: exports.IMimeDocumentTracker,
|
|
43
|
+
autoStart: true,
|
|
44
|
+
activate: (app, restorer) => {
|
|
45
|
+
restorer.restore(tracker, {
|
|
46
|
+
command: 'docmanager:open',
|
|
47
|
+
args: widget => ({
|
|
48
|
+
path: widget.context.path,
|
|
49
|
+
factory: Private.factoryNameProperty.get(widget)
|
|
50
|
+
}),
|
|
51
|
+
name: widget => `${widget.context.path}:${Private.factoryNameProperty.get(widget)}`
|
|
52
|
+
});
|
|
53
|
+
return tracker;
|
|
54
|
+
}
|
|
55
|
+
});
|
|
56
|
+
return plugins;
|
|
57
|
+
}
|
|
58
|
+
exports.createRendermimePlugins = createRendermimePlugins;
|
|
59
|
+
/**
|
|
60
|
+
* Create rendermime plugins for rendermime extension modules.
|
|
61
|
+
*/
|
|
62
|
+
function createRendermimePlugin(tracker, item) {
|
|
63
|
+
return {
|
|
64
|
+
id: item.id,
|
|
65
|
+
requires: [layoutrestorer_1.ILayoutRestorer, rendermime_1.IRenderMimeRegistry],
|
|
66
|
+
autoStart: true,
|
|
67
|
+
activate: (app, restorer, rendermime) => {
|
|
68
|
+
// Add the mime renderer.
|
|
69
|
+
if (item.rank !== undefined) {
|
|
70
|
+
rendermime.addFactory(item.rendererFactory, item.rank);
|
|
71
|
+
}
|
|
72
|
+
else {
|
|
73
|
+
rendermime.addFactory(item.rendererFactory);
|
|
74
|
+
}
|
|
75
|
+
// Handle the widget factory.
|
|
76
|
+
if (!item.documentWidgetFactoryOptions) {
|
|
77
|
+
return;
|
|
78
|
+
}
|
|
79
|
+
let registry = app.docRegistry;
|
|
80
|
+
let options = [];
|
|
81
|
+
if (Array.isArray(item.documentWidgetFactoryOptions)) {
|
|
82
|
+
options = item.documentWidgetFactoryOptions;
|
|
83
|
+
}
|
|
84
|
+
else {
|
|
85
|
+
options = [
|
|
86
|
+
item.documentWidgetFactoryOptions
|
|
87
|
+
];
|
|
88
|
+
}
|
|
89
|
+
if (item.fileTypes) {
|
|
90
|
+
item.fileTypes.forEach(ft => {
|
|
91
|
+
app.docRegistry.addFileType(ft);
|
|
92
|
+
});
|
|
93
|
+
}
|
|
94
|
+
options.forEach(option => {
|
|
95
|
+
const toolbarFactory = option.toolbarFactory
|
|
96
|
+
? (w) => option.toolbarFactory(w.content.renderer)
|
|
97
|
+
: undefined;
|
|
98
|
+
let factory = new docregistry_1.MimeDocumentFactory({
|
|
99
|
+
renderTimeout: item.renderTimeout,
|
|
100
|
+
dataType: item.dataType,
|
|
101
|
+
rendermime,
|
|
102
|
+
modelName: option.modelName,
|
|
103
|
+
name: option.name,
|
|
104
|
+
primaryFileType: registry.getFileType(option.primaryFileType),
|
|
105
|
+
fileTypes: option.fileTypes,
|
|
106
|
+
defaultFor: option.defaultFor,
|
|
107
|
+
defaultRendered: option.defaultRendered,
|
|
108
|
+
toolbarFactory
|
|
109
|
+
});
|
|
110
|
+
registry.addWidgetFactory(factory);
|
|
111
|
+
factory.widgetCreated.connect((sender, widget) => {
|
|
112
|
+
Private.factoryNameProperty.set(widget, factory.name);
|
|
113
|
+
// Notify the instance tracker if restore data needs to update.
|
|
114
|
+
widget.context.pathChanged.connect(() => {
|
|
115
|
+
tracker.save(widget);
|
|
116
|
+
});
|
|
117
|
+
tracker.add(widget);
|
|
118
|
+
});
|
|
119
|
+
});
|
|
120
|
+
}
|
|
121
|
+
};
|
|
122
|
+
}
|
|
123
|
+
exports.createRendermimePlugin = createRendermimePlugin;
|
|
124
|
+
/**
|
|
125
|
+
* Private namespace for the module.
|
|
126
|
+
*/
|
|
127
|
+
var Private;
|
|
128
|
+
(function (Private) {
|
|
129
|
+
/**
|
|
130
|
+
* An attached property for keeping the factory name
|
|
131
|
+
* that was used to create a mimedocument.
|
|
132
|
+
*/
|
|
133
|
+
Private.factoryNameProperty = new properties_1.AttachedProperty({
|
|
134
|
+
name: 'factoryName',
|
|
135
|
+
create: () => undefined
|
|
136
|
+
});
|
|
137
|
+
})(Private || (Private = {}));
|