@jupyterlab/notebook 3.4.3 → 4.0.0-alpha.11

package/lib/searchprovider.js

@@ -0,0 +1,421 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { createCellSearchProvider, SELECTED_HIGHLIGHT_CLASS } from '@jupyterlab/cells';
+import { SearchProvider } from '@jupyterlab/documentsearch';
+import { nullTranslator } from '@jupyterlab/translation';
+import { ArrayExt } from '@lumino/algorithm';
+import { NotebookPanel } from './panel';
+/**
+ * Notebook document search provider
+ */
+export class NotebookSearchProvider extends SearchProvider {
+    /**
+     * Constructor
+     *
+     * @param widget The widget to search in
+     * @param translator Application translator
+     */
+    constructor(widget, translator = nullTranslator) {
+        super(widget);
+        this.translator = translator;
+        this._currentProviderIndex = null;
+        this._onSelectedCells = false;
+        this._query = null;
+        this._searchProviders = [];
+        this._documentHasChanged = false;
+        this.widget.model.cells.changed.connect(this._onCellsChanged, this);
+        this.widget.content.activeCellChanged.connect(this._onActiveCellChanged, this);
+        this.widget.content.placeholderCellRendered.connect(this._onPlaceholderRendered, this);
+    }
+    /**
+     * Report whether or not this provider has the ability to search on the given object
+     *
+     * @param domain Widget to test
+     * @returns Search ability
+     */
+    static isApplicable(domain) {
+        // check to see if the CMSearchProvider can search on the
+        // first cell, false indicates another editor is present
+        return domain instanceof NotebookPanel;
+    }
+    /**
+     * Instantiate a search provider for the notebook panel.
+     *
+     * #### Notes
+     * The widget provided is always checked using `isApplicable` before calling
+     * this factory.
+     *
+     * @param widget The widget to search on
+     * @param translator [optional] The translator object
+     *
+     * @returns The search provider on the notebook panel
+     */
+    static createNew(widget, translator) {
+        return new NotebookSearchProvider(widget, translator);
+    }
+    /**
+     * The current index of the selected match.
+     */
+    get currentMatchIndex() {
+        let agg = 0;
+        let found = false;
+        for (let idx = 0; idx < this._searchProviders.length; idx++) {
+            const provider = this._searchProviders[idx];
+            const localMatch = provider.currentMatchIndex;
+            if (localMatch !== null) {
+                agg += localMatch;
+                found = true;
+                break;
+            }
+            else {
+                agg += provider.matchesCount;
+            }
+        }
+        return found ? agg : null;
+    }
+    /**
+     * The number of matches.
+     */
+    get matchesCount() {
+        return this._searchProviders.reduce((sum, provider) => (sum += provider.matchesCount), 0);
+    }
+    /**
+     * Set to true if the widget under search is read-only, false
+     * if it is editable.  Will be used to determine whether to show
+     * the replace option.
+     */
+    get isReadOnly() {
+        var _a, _b, _c;
+        return (_c = (_b = (_a = this.widget) === null || _a === void 0 ? void 0 : _a.content.model) === null || _b === void 0 ? void 0 : _b.readOnly) !== null && _c !== void 0 ? _c : false;
+    }
+    /**
+     * Dispose of the resources held by the search provider.
+     *
+     * #### Notes
+     * If the object's `dispose` method is called more than once, all
+     * calls made after the first will be a no-op.
+     *
+     * #### Undefined Behavior
+     * It is undefined behavior to use any functionality of the object
+     * after it has been disposed unless otherwise explicitly noted.
+     */
+    dispose() {
+        var _a;
+        if (this.isDisposed) {
+            return;
+        }
+        this.widget.content.placeholderCellRendered.disconnect(this._onPlaceholderRendered, this);
+        this.widget.content.activeCellChanged.disconnect(this._onActiveCellChanged, this);
+        (_a = this.widget.model) === null || _a === void 0 ? void 0 : _a.cells.changed.disconnect(this._onCellsChanged, this);
+        super.dispose();
+        const index = this.widget.content.activeCellIndex;
+        this.endQuery()
+            .then(() => {
+            if (!this.widget.isDisposed) {
+                this.widget.content.activeCellIndex = index;
+            }
+        })
+            .catch(reason => {
+            console.error(`Fail to end search query in notebook:\n${reason}`);
+        });
+    }
+    /**
+     * Get the filters for the given provider.
+     *
+     * @returns The filters.
+     */
+    getFilters() {
+        const trans = this.translator.load('jupyterlab');
+        return {
+            output: {
+                title: trans.__('Search Cell Outputs'),
+                description: trans.__('Search in the cell outputs.'),
+                default: false,
+                supportReplace: false
+            },
+            selectedCells: {
+                title: trans.__('Search Selected Cell(s)'),
+                description: trans.__('Search only in the selected cell(s).'),
+                default: false,
+                supportReplace: true
+            }
+        };
+    }
+    /**
+     * Get an initial query value if applicable so that it can be entered
+     * into the search box as an initial query
+     *
+     * @returns Initial value used to populate the search box.
+     */
+    getInitialQuery() {
+        var _a;
+        const activeCell = this.widget.content.activeCell;
+        const selection = (_a = activeCell === null || activeCell === void 0 ? void 0 : activeCell.editor) === null || _a === void 0 ? void 0 : _a.doc.getSelection();
+        // if there are newlines, just return empty string
+        return (selection === null || selection === void 0 ? void 0 : selection.search(/\r?\n|\r/g)) === -1 ? selection : '';
+    }
+    /**
+     * Clear currently highlighted match.
+     */
+    async clearHighlight() {
+        if (this._currentProviderIndex !== null) {
+            await this._searchProviders[this._currentProviderIndex].clearHighlight();
+            this._currentProviderIndex = null;
+        }
+    }
+    /**
+     * Highlight the next match.
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The next match if available.
+     */
+    async highlightNext(loop = true) {
+        const match = await this._stepNext(false, loop);
+        return match !== null && match !== void 0 ? match : undefined;
+    }
+    /**
+     * Highlight the previous match.
+     *
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns The previous match if available.
+     */
+    async highlightPrevious(loop = true) {
+        const match = await this._stepNext(true, loop);
+        return match !== null && match !== void 0 ? match : undefined;
+    }
+    /**
+     * Search for a regular expression with optional filters.
+     *
+     * @param query A regular expression to test for
+     * @param filters Filter parameters to pass to provider
+     *
+     */
+    async startQuery(query, filters) {
+        if (!this.widget) {
+            return;
+        }
+        await this.endQuery();
+        let cells = this.widget.content.widgets;
+        this._query = query;
+        this._filters = Object.assign({ output: false, selectedCells: false }, (filters !== null && filters !== void 0 ? filters : {}));
+        this._onSelectedCells = this._filters.selectedCells;
+        if (this._filters.selectedCells) {
+            this.widget.content.selectionChanged.connect(this._onSelectionChanged, this);
+        }
+        // For each cell, create a search provider
+        this._searchProviders = await Promise.all(cells.map(async (cell) => {
+            const cellSearchProvider = createCellSearchProvider(cell);
+            cellSearchProvider.stateChanged.connect(this._onSearchProviderChanged, this);
+            await cellSearchProvider.setIsActive(!this._filters.selectedCells ||
+                this.widget.content.isSelectedOrActive(cell));
+            await cellSearchProvider.startQuery(query, this._filters);
+            return cellSearchProvider;
+        }));
+        this._currentProviderIndex = this.widget.content.activeCellIndex;
+        if (!this._documentHasChanged) {
+            await this.highlightNext(false);
+        }
+        this._documentHasChanged = false;
+        return Promise.resolve();
+    }
+    /**
+     * Stop the search and clear all internal state.
+     */
+    async endQuery() {
+        await Promise.all(this._searchProviders.map(provider => {
+            provider.stateChanged.disconnect(this._onSearchProviderChanged, this);
+            return provider.endQuery().then(() => {
+                provider.dispose();
+            });
+        }));
+        this._searchProviders.length = 0;
+        this._currentProviderIndex = null;
+    }
+    /**
+     * Replace the currently selected match with the provided text
+     *
+     * @param newText The replacement text.
+     * @param loop Whether to loop within the matches list.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    async replaceCurrentMatch(newText, loop = true) {
+        let replaceOccurred = false;
+        const unrenderMarkdownCell = async (highlightNext = false) => {
+            var _a;
+            // Unrendered markdown cell
+            const activeCell = (_a = this.widget) === null || _a === void 0 ? void 0 : _a.content.activeCell;
+            if ((activeCell === null || activeCell === void 0 ? void 0 : activeCell.model.type) === 'markdown' &&
+                activeCell.rendered) {
+                activeCell.rendered = false;
+                if (highlightNext) {
+                    await this.highlightNext(loop);
+                }
+            }
+        };
+        if (this._currentProviderIndex !== null) {
+            await unrenderMarkdownCell();
+            const searchEngine = this._searchProviders[this._currentProviderIndex];
+            replaceOccurred = await searchEngine.replaceCurrentMatch(newText);
+        }
+        await this.highlightNext(loop);
+        // Force highlighting the first hit in the unrendered cell
+        await unrenderMarkdownCell(true);
+        return replaceOccurred;
+    }
+    /**
+     * Replace all matches in the notebook with the provided text
+     *
+     * @param newText The replacement text.
+     *
+     * @returns A promise that resolves with a boolean indicating whether a replace occurred.
+     */
+    async replaceAllMatches(newText) {
+        const replacementOccurred = await Promise.all(this._searchProviders.map(provider => {
+            return provider.replaceAllMatches(newText);
+        }));
+        return replacementOccurred.includes(true);
+    }
+    _addCellProvider(index) {
+        var _a, _b;
+        const cell = this.widget.content.widgets[index];
+        const cellSearchProvider = createCellSearchProvider(cell);
+        cellSearchProvider.stateChanged.connect(this._onSearchProviderChanged, this);
+        ArrayExt.insert(this._searchProviders, index, cellSearchProvider);
+        cellSearchProvider
+            .setIsActive(!((_b = (_a = this._filters) === null || _a === void 0 ? void 0 : _a.selectedCells) !== null && _b !== void 0 ? _b : false) ||
+            this.widget.content.isSelectedOrActive(cell))
+            .then(() => {
+            cellSearchProvider.startQuery(this._query, this._filters);
+        });
+    }
+    _removeCellProvider(index) {
+        const provider = ArrayExt.removeAt(this._searchProviders, index);
+        provider === null || provider === void 0 ? void 0 : provider.stateChanged.disconnect(this._onSearchProviderChanged, this);
+        provider === null || provider === void 0 ? void 0 : provider.dispose();
+    }
+    async _onCellsChanged(cells, changes) {
+        await this.clearHighlight();
+        switch (changes.type) {
+            case 'add':
+                changes.newValues.forEach((model, index) => {
+                    this._addCellProvider(changes.newIndex + index);
+                });
+                break;
+            case 'move':
+                ArrayExt.move(this._searchProviders, changes.oldIndex, changes.newIndex);
+                break;
+            case 'remove':
+                for (let index = 0; index < changes.oldValues.length; index++) {
+                    this._removeCellProvider(changes.oldIndex);
+                }
+                break;
+            case 'set':
+                changes.newValues.forEach((model, index) => {
+                    this._addCellProvider(changes.newIndex + index);
+                    this._removeCellProvider(changes.newIndex + index + 1);
+                });
+                break;
+        }
+        this._onSearchProviderChanged();
+    }
+    _onPlaceholderRendered(panel, renderedCell) {
+        const index = panel.widgets.findIndex(cell => cell.id === renderedCell.id);
+        if (index >= 0) {
+            void this._onCellsChanged(panel.model.cells, {
+                newIndex: index,
+                newValues: [renderedCell.model],
+                oldIndex: index,
+                oldValues: [renderedCell.model],
+                type: 'set'
+            });
+        }
+    }
+    async _stepNext(reverse = false, loop = false) {
+        const activateNewMatch = () => {
+            var _a;
+            if (this.widget.content.activeCellIndex !== this._currentProviderIndex) {
+                this.widget.content.activeCellIndex = this._currentProviderIndex;
+            }
+            const activeCell = this.widget.content.activeCell;
+            // Unhide cell
+            if (activeCell.inputHidden) {
+                activeCell.inputHidden = false;
+            }
+            // scroll to newly activate highlight
+            const containerRect = this.widget.content.node.getBoundingClientRect();
+            const element = (_a = activeCell.node.querySelector(`.${SELECTED_HIGHLIGHT_CLASS}`)) !== null && _a !== void 0 ? _a : activeCell.node.querySelector('.CodeMirror-selected');
+            if (element) {
+                const elementRect = element.getBoundingClientRect();
+                if (elementRect.top < containerRect.top ||
+                    elementRect.top > containerRect.bottom) {
+                    element.scrollIntoView({ block: 'center' });
+                }
+            }
+        };
+        if (this._currentProviderIndex === null) {
+            this._currentProviderIndex = this.widget.content.activeCellIndex;
+        }
+        const startIndex = this._currentProviderIndex;
+        do {
+            const searchEngine = this._searchProviders[this._currentProviderIndex];
+            const match = reverse
+                ? await searchEngine.highlightPrevious()
+                : await searchEngine.highlightNext();
+            if (match) {
+                activateNewMatch();
+                return match;
+            }
+            else {
+                this._currentProviderIndex =
+                    this._currentProviderIndex + (reverse ? -1 : 1);
+                if (loop) {
+                    // We loop on all cells, not hit found
+                    if (this._currentProviderIndex === startIndex) {
+                        break;
+                    }
+                    this._currentProviderIndex =
+                        (this._currentProviderIndex + this._searchProviders.length) %
+                            this._searchProviders.length;
+                }
+            }
+        } while (0 <= this._currentProviderIndex &&
+            this._currentProviderIndex < this._searchProviders.length);
+        if (loop) {
+            // Search a last time in the first provider as it may contain more
+            // than one matches
+            const searchEngine = this._searchProviders[this._currentProviderIndex];
+            const match = reverse
+                ? await searchEngine.highlightPrevious()
+                : await searchEngine.highlightNext();
+            if (match) {
+                activateNewMatch();
+                return match;
+            }
+        }
+        this._currentProviderIndex = null;
+        return null;
+    }
+    async _onActiveCellChanged() {
+        await this._onSelectionChanged();
+        if (this.widget.content.activeCellIndex !== this._currentProviderIndex) {
+            await this.clearHighlight();
+        }
+    }
+    _onSearchProviderChanged() {
+        // Don't highlight the next occurrence when the query
+        // follows a document change
+        this._documentHasChanged = true;
+        this._stateChanged.emit();
+    }
+    async _onSelectionChanged() {
+        if (this._onSelectedCells) {
+            const cells = this.widget.content.widgets;
+            await Promise.all(this._searchProviders.map((provider, index) => provider.setIsActive(this.widget.content.isSelectedOrActive(cells[index]))));
+            this._onSearchProviderChanged();
+        }
+    }
+}
+//# sourceMappingURL=searchprovider.js.map

package/lib/searchprovider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchprovider.js","sourceRoot":"","sources":["../src/searchprovider.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,OAAO,EAGL,wBAAwB,EAGxB,wBAAwB,EACzB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAKL,cAAc,EACf,MAAM,4BAA4B,CAAC;AAKpC,OAAO,EAAe,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAGxC;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,cAA6B;IACvE;;;;;OAKG;IACH,YACE,MAAqB,EACX,aAA0B,cAAc;QAElD,KAAK,CAAC,MAAM,CAAC,CAAC;QAFJ,eAAU,GAAV,UAAU,CAA8B;QA4gB5C,0BAAqB,GAAkB,IAAI,CAAC;QAE5C,qBAAgB,GAAG,KAAK,CAAC;QACzB,WAAM,GAAkB,IAAI,CAAC;QAC7B,qBAAgB,GAAyB,EAAE,CAAC;QAC5C,wBAAmB,GAAG,KAAK,CAAC;QA7gBlC,IAAI,CAAC,MAAM,CAAC,KAAM,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,OAAO,CAC3C,IAAI,CAAC,oBAAoB,EACzB,IAAI,CACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,OAAO,CACjD,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CACL,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,MAAc;QAChC,yDAAyD;QACzD,wDAAwD;QACxD,OAAO,MAAM,YAAY,aAAa,CAAC;IACzC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,SAAS,CACd,MAAqB,EACrB,UAAwB;QAExB,OAAO,IAAI,sBAAsB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACxD,CAAC;IAED;;OAEG;IACH,IAAI,iBAAiB;QACnB,IAAI,GAAG,GAAG,CAAC,CAAC;QACZ,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;YAC5C,MAAM,UAAU,GAAG,QAAQ,CAAC,iBAAiB,CAAC;YAC9C,IAAI,UAAU,KAAK,IAAI,EAAE;gBACvB,GAAG,IAAI,UAAU,CAAC;gBAClB,KAAK,GAAG,IAAI,CAAC;gBACb,MAAM;aACP;iBAAM;gBACL,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC;aAC9B;SACF;QACD,OAAO,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,gBAAgB,CAAC,MAAM,CACjC,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,EACjD,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI,UAAU;;QACZ,OAAO,MAAA,MAAA,MAAA,IAAI,CAAC,MAAM,0CAAE,OAAO,CAAC,KAAK,0CAAE,QAAQ,mCAAI,KAAK,CAAC;IACvD,CAAC;IAED;;;;;;;;;;OAUG;IACH,OAAO;;QACL,IAAI,IAAI,CAAC,UAAU,EAAE;YACnB,OAAO;SACR;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,UAAU,CACpD,IAAI,CAAC,sBAAsB,EAC3B,IAAI,CACL,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAC9C,IAAI,CAAC,oBAAoB,EACzB,IAAI,CACL,CAAC;QACF,MAAA,IAAI,CAAC,MAAM,CAAC,KAAK,0CAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QAExE,KAAK,CAAC,OAAO,EAAE,CAAC;QAEhB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;QAClD,IAAI,CAAC,QAAQ,EAAE;aACZ,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC;aAC7C;QACH,CAAC,CAAC;aACD,KAAK,CAAC,MAAM,CAAC,EAAE;YACd,OAAO,CAAC,KAAK,CAAC,0CAA0C,MAAM,EAAE,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACH,UAAU;QACR,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAEjD,OAAO;YACL,MAAM,EAAE;gBACN,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,qBAAqB,CAAC;gBACtC,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,6BAA6B,CAAC;gBACpD,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,KAAK;aACtB;YACD,aAAa,EAAE;gBACb,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,yBAAyB,CAAC;gBAC1C,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC,sCAAsC,CAAC;gBAC7D,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,IAAI;aACrB;SACF,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,eAAe;;QACb,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QAClD,MAAM,SAAS,GAAG,MAChB,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,MACb,0CAAE,GAAG,CAAC,YAAY,EAAE,CAAC;QACtB,kDAAkD;QAClD,OAAO,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,MAAM,CAAC,WAAW,CAAC,MAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC;IAChE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,IAAI,CAAC,qBAAqB,KAAK,IAAI,EAAE;YACvC,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,cAAc,EAAE,CAAC;YACzE,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;SACnC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,aAAa,CAAC,OAAgB,IAAI;QACtC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAChD,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,SAAS,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAgB,IAAI;QAEpB,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC/C,OAAO,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,SAAS,CAAC;IAC5B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,KAAa,EACb,OAA6B;QAE7B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,OAAO;SACR;QACD,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACtB,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;QAExC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,QAAQ,mBACX,MAAM,EAAE,KAAK,EACb,aAAa,EAAE,KAAK,IACjB,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC,CACnB,CAAC;QAEF,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;QACpD,IAAI,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;YAC/B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAC1C,IAAI,CAAC,mBAAmB,EACxB,IAAI,CACL,CAAC;SACH;QAED,0CAA0C;QAC1C,IAAI,CAAC,gBAAgB,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YACrB,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;YAC1D,kBAAkB,CAAC,YAAY,CAAC,OAAO,CACrC,IAAI,CAAC,wBAAwB,EAC7B,IAAI,CACL,CAAC;YAEF,MAAM,kBAAkB,CAAC,WAAW,CAClC,CAAC,IAAI,CAAC,QAAS,CAAC,aAAa;gBAC3B,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAC/C,CAAC;YACF,MAAM,kBAAkB,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;YAE1D,OAAO,kBAAkB,CAAC;QAC5B,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;QAEjE,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE;YAC7B,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;SACjC;QACD,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;QAEjC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ;QACZ,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACnC,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;YAEtE,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;gBACnC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACrB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CACH,CAAC;QAEF,IAAI,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,CAAC;QACjC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;IACpC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CAAC,OAAe,EAAE,IAAI,GAAG,IAAI;QACpD,IAAI,eAAe,GAAG,KAAK,CAAC;QAE5B,MAAM,oBAAoB,GAAG,KAAK,EAChC,aAAa,GAAG,KAAK,EACN,EAAE;;YACjB,2BAA2B;YAC3B,MAAM,UAAU,GAAG,MAAA,IAAI,CAAC,MAAM,0CAAE,OAAO,CAAC,UAAU,CAAC;YACnD,IACE,CAAA,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,KAAK,CAAC,IAAI,MAAK,UAAU;gBACpC,UAA2B,CAAC,QAAQ,EACrC;gBACC,UAA2B,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC9C,IAAI,aAAa,EAAE;oBACjB,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;iBAChC;aACF;QACH,CAAC,CAAC;QAEF,IAAI,IAAI,CAAC,qBAAqB,KAAK,IAAI,EAAE;YACvC,MAAM,oBAAoB,EAAE,CAAC;YAE7B,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACvE,eAAe,GAAG,MAAM,YAAY,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;SACnE;QAED,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;QAC/B,0DAA0D;QAC1D,MAAM,oBAAoB,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,eAAe,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAe;QACrC,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACnC,OAAO,QAAQ,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAC7C,CAAC,CAAC,CACH,CAAC;QACF,OAAO,mBAAmB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAEO,gBAAgB,CAAC,KAAa;;QACpC,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAChD,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,IAAI,CAAC,CAAC;QAC1D,kBAAkB,CAAC,YAAY,CAAC,OAAO,CACrC,IAAI,CAAC,wBAAwB,EAC7B,IAAI,CACL,CAAC;QAEF,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,EAAE,kBAAkB,CAAC,CAAC;QAElE,kBAAkB;aACf,WAAW,CACV,CAAC,CAAC,MAAA,MAAA,IAAI,CAAC,QAAQ,0CAAE,aAAa,mCAAI,KAAK,CAAC;YACtC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAC/C;aACA,IAAI,CAAC,GAAG,EAAE;YACT,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,mBAAmB,CAAC,KAAa;QACvC,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;QACjE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,YAAY,CAAC,UAAU,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QACvE,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,EAAE,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,eAAe,CAC3B,KAA0C,EAC1C,OAAiD;QAEjD,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAE5B,QAAQ,OAAO,CAAC,IAAI,EAAE;YACpB,KAAK,KAAK;gBACR,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACzC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC;gBAClD,CAAC,CAAC,CAAC;gBACH,MAAM;YACR,KAAK,MAAM;gBACT,QAAQ,CAAC,IAAI,CACX,IAAI,CAAC,gBAAgB,EACrB,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,QAAQ,CACjB,CAAC;gBACF,MAAM;YACR,KAAK,QAAQ;gBACX,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;oBAC7D,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;iBAC5C;gBACD,MAAM;YACR,KAAK,KAAK;gBACR,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;oBACzC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC,CAAC;oBAChD,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,QAAQ,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;gBACzD,CAAC,CAAC,CAAC;gBAEH,MAAM;SACT;QACD,IAAI,CAAC,wBAAwB,EAAE,CAAC;IAClC,CAAC;IAEO,sBAAsB,CAC5B,KAAe,EACf,YAA8B;QAE9B,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAC,CAAC;QAC3E,IAAI,KAAK,IAAI,CAAC,EAAE;YACd,KAAK,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,KAAM,CAAC,KAAK,EAAE;gBAC5C,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;gBAC/B,QAAQ,EAAE,KAAK;gBACf,SAAS,EAAE,CAAC,YAAY,CAAC,KAAK,CAAC;gBAC/B,IAAI,EAAE,KAAK;aACZ,CAAC,CAAC;SACJ;IACH,CAAC;IAEO,KAAK,CAAC,SAAS,CACrB,OAAO,GAAG,KAAK,EACf,IAAI,GAAG,KAAK;QAEZ,MAAM,gBAAgB,GAAG,GAAG,EAAE;;YAC5B,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,IAAI,CAAC,qBAAsB,EAAE;gBACvE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,qBAAsB,CAAC;aACnE;YACD,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,UAAW,CAAC;YACnD,cAAc;YACd,IAAI,UAAU,CAAC,WAAW,EAAE;gBAC1B,UAAU,CAAC,WAAW,GAAG,KAAK,CAAC;aAChC;YACD,qCAAqC;YACrC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC;YACvE,MAAM,OAAO,GACX,MAAA,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,wBAAwB,EAAE,CAAC,mCAC7D,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,sBAAsB,CAAC,CAAC;YACxD,IAAI,OAAO,EAAE;gBACX,MAAM,WAAW,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;gBACpD,IACE,WAAW,CAAC,GAAG,GAAG,aAAa,CAAC,GAAG;oBACnC,WAAW,CAAC,GAAG,GAAG,aAAa,CAAC,MAAM,EACtC;oBACA,OAAO,CAAC,cAAc,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;iBAC7C;aACF;QACH,CAAC,CAAC;QAEF,IAAI,IAAI,CAAC,qBAAqB,KAAK,IAAI,EAAE;YACvC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC;SAClE;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC9C,GAAG;YACD,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAEvE,MAAM,KAAK,GAAG,OAAO;gBACnB,CAAC,CAAC,MAAM,YAAY,CAAC,iBAAiB,EAAE;gBACxC,CAAC,CAAC,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YAEvC,IAAI,KAAK,EAAE;gBACT,gBAAgB,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;aACd;iBAAM;gBACL,IAAI,CAAC,qBAAqB;oBACxB,IAAI,CAAC,qBAAqB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;gBAElD,IAAI,IAAI,EAAE;oBACR,sCAAsC;oBACtC,IAAI,IAAI,CAAC,qBAAqB,KAAK,UAAU,EAAE;wBAC7C,MAAM;qBACP;oBAED,IAAI,CAAC,qBAAqB;wBACxB,CAAC,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;4BAC3D,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC;iBAChC;aACF;SACF,QACC,CAAC,IAAI,IAAI,CAAC,qBAAqB;YAC/B,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,EACzD;QAEF,IAAI,IAAI,EAAE;YACR,kEAAkE;YAClE,mBAAmB;YACnB,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACvE,MAAM,KAAK,GAAG,OAAO;gBACnB,CAAC,CAAC,MAAM,YAAY,CAAC,iBAAiB,EAAE;gBACxC,CAAC,CAAC,MAAM,YAAY,CAAC,aAAa,EAAE,CAAC;YAEvC,IAAI,KAAK,EAAE;gBACT,gBAAgB,EAAE,CAAC;gBACnB,OAAO,KAAK,CAAC;aACd;SACF;QAED,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,eAAe,KAAK,IAAI,CAAC,qBAAqB,EAAE;YACtE,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;SAC7B;IACH,CAAC;IAEO,wBAAwB;QAC9B,qDAAqD;QACrD,4BAA4B;QAC5B,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;QAChC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;IAC5B,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,IAAI,IAAI,CAAC,gBAAgB,EAAE;YACzB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC;YAC1C,MAAM,OAAO,CAAC,GAAG,CACf,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAC5C,QAAQ,CAAC,WAAW,CAClB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CACrD,CACF,CACF,CAAC;YAEF,IAAI,CAAC,wBAAwB,EAAE,CAAC;SACjC;IACH,CAAC;CAQF"}

package/lib/toc.d.ts

@@ -0,0 +1,179 @@
+import { ISanitizer } from '@jupyterlab/apputils';
+import { Cell, ICellModel } from '@jupyterlab/cells';
+import { IMarkdownParser } from '@jupyterlab/rendermime';
+import { TableOfContents, TableOfContentsFactory, TableOfContentsModel } from '@jupyterlab/toc';
+import { NotebookPanel } from './panel';
+import { INotebookTracker } from './tokens';
+import { Notebook } from './widget';
+/**
+ * Cell running status
+ */
+export declare enum RunningStatus {
+    /**
+     * Cell is idle
+     */
+    Idle = -1,
+    /**
+     * Cell execution is scheduled
+     */
+    Scheduled = 0,
+    /**
+     * Cell is running
+     */
+    Running = 1
+}
+/**
+ * Type of headings
+ */
+export declare enum HeadingType {
+    /**
+     * Heading from HTML output
+     */
+    HTML = 0,
+    /**
+     * Heading from Markdown cell or Markdown output
+     */
+    Markdown = 1
+}
+/**
+ * Interface describing a notebook cell heading.
+ */
+export interface INotebookHeading extends TableOfContents.IHeading {
+    /**
+     * Reference to a notebook cell.
+     */
+    cellRef: Cell;
+    /**
+     * Running status of the cells in the heading
+     */
+    isRunning: RunningStatus;
+    /**
+     * Index of the output containing the heading
+     */
+    outputIndex?: number;
+    /**
+     * Type of heading
+     */
+    type: HeadingType;
+}
+/**
+ * Table of content model for Notebook files.
+ */
+export declare class NotebookToCModel extends TableOfContentsModel<INotebookHeading, NotebookPanel> {
+    protected parser: IMarkdownParser | null;
+    protected sanitizer: ISanitizer;
+    /**
+     * Constructor
+     *
+     * @param widget The widget to search in
+     * @param parser Markdown parser
+     * @param sanitizer Sanitizer
+     * @param configuration Default model configuration
+     */
+    constructor(widget: NotebookPanel, parser: IMarkdownParser | null, sanitizer: ISanitizer, configuration?: TableOfContents.IConfig);
+    /**
+     * Type of document supported by the model.
+     *
+     * #### Notes
+     * A `data-document-type` attribute with this value will be set
+     * on the tree view `.jp-TableOfContents-content[data-document-type="..."]`
+     */
+    get documentType(): string;
+    /**
+     * Whether the model gets updated even if the table of contents panel
+     * is hidden or not.
+     */
+    protected get isAlwaysActive(): boolean;
+    /**
+     * List of configuration options supported by the model.
+     */
+    get supportedOptions(): (keyof TableOfContents.IConfig)[];
+    /**
+     * Get the first heading of a given cell.
+     *
+     * It will be `null` if the cell has no headings.
+     *
+     * @param cell Cell
+     * @returns The associated heading
+     */
+    getCellHeading(cell: Cell): INotebookHeading | null;
+    /**
+     * Dispose the object
+     */
+    dispose(): void;
+    /**
+     * Model configuration setter.
+     *
+     * @param c New configuration
+     */
+    setConfiguration(c: Partial<TableOfContents.IConfig>): void;
+    /**
+     * Callback on heading collapse.
+     *
+     * @param options.heading The heading to change state (all headings if not provided)
+     * @param options.collapsed The new collapsed status (toggle existing status if not provided)
+     */
+    toggleCollapse(options: {
+        heading?: INotebookHeading;
+        collapsed?: boolean;
+    }): void;
+    /**
+     * Produce the headings for a document.
+     *
+     * @returns The list of new headings or `null` if nothing needs to be updated.
+     */
+    protected getHeadings(): Promise<INotebookHeading[] | null>;
+    /**
+     * Read table of content configuration from notebook metadata.
+     *
+     * @returns ToC configuration from metadata
+     */
+    protected loadConfigurationFromMetadata(): Partial<TableOfContents.IConfig>;
+    protected onActiveCellChanged(notebook: Notebook, cell: Cell<ICellModel>): void;
+    protected onHeadingsChanged(): void;
+    protected onExecuted(_: unknown, args: {
+        notebook: Notebook;
+        cell: Cell;
+    }): void;
+    protected onExecutionScheduled(_: unknown, args: {
+        notebook: Notebook;
+        cell: Cell;
+    }): void;
+    protected onMetadataChanged(): void;
+    protected updateRunningStatus(headings: INotebookHeading[]): void;
+    /**
+     * Mapping between configuration options and notebook metadata.
+     *
+     * If it starts with `!`, the boolean value of the configuration option is
+     * opposite to the one stored in metadata.
+     * If it contains `/`, the metadata data is nested.
+     */
+    protected configMetadataMap: {
+        [k: keyof TableOfContents.IConfig]: string[];
+    };
+    private _runningCells;
+    private _cellToHeadingIndex;
+}
+/**
+ * Table of content model factory for Notebook files.
+ */
+export declare class NotebookToCFactory extends TableOfContentsFactory<NotebookPanel> {
+    protected parser: IMarkdownParser | null;
+    protected sanitizer: ISanitizer;
+    /**
+     * Constructor
+     *
+     * @param tracker Widget tracker
+     * @param parser Markdown parser
+     * @param sanitizer Sanitizer
+     */
+    constructor(tracker: INotebookTracker, parser: IMarkdownParser | null, sanitizer: ISanitizer);
+    /**
+     * Create a new table of contents model for the widget
+     *
+     * @param widget - widget
+     * @param configuration - Table of contents configuration
+     * @returns The table of contents model
+     */
+    protected _createNew(widget: NotebookPanel, configuration?: TableOfContents.IConfig): TableOfContentsModel<TableOfContents.IHeading, NotebookPanel>;
+}