@jupyter-notebook/application 7.0.3 → 7.0.5

package/lib/app.d.ts

@@ -57,7 +57,7 @@ export declare class NotebookApp extends JupyterFrontEnd<INotebookShell> {
     private _formatter;
 }
 /**
- * A namespace for App statics.
+ * A namespace for App static items.
  */
 export declare namespace NotebookApp {
     /**

package/lib/index.d.ts

@@ -1,3 +1,5 @@
 export * from './app';
 export * from './shell';
 export * from './panelhandler';
+export * from './pathopener';
+export * from './tokens';

package/lib/index.js

@@ -3,3 +3,5 @@
 export * from './app';
 export * from './shell';
 export * from './panelhandler';
+export * from './pathopener';
+export * from './tokens';

package/lib/panelhandler.js

@@ -291,7 +291,7 @@ export class SidePanelPalette {
                 id: widget.id,
             },
         });
-        // Keep the disposableDelegate objet to be able to dispose of the item if the widget
+        // Keep the disposableDelegate object to be able to dispose of the item if the widget
         // is remove from the side panel.
         this._items.push({
             widgetId: widget.id,

package/lib/pathopener.d.ts

@@ -0,0 +1,12 @@
+import { INotebookPathOpener } from './tokens';
+/**
+ * A class to open paths in new browser tabs in the Notebook application.
+ */
+declare class DefaultNotebookPathOpener implements INotebookPathOpener {
+    /**
+     * Open a path in a new browser tab.
+     */
+    open(options: INotebookPathOpener.IOpenOptions): WindowProxy | null;
+}
+export declare const defaultNotebookPathOpener: DefaultNotebookPathOpener;
+export {};

package/lib/pathopener.js

@@ -0,0 +1,20 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+import { URLExt } from '@jupyterlab/coreutils';
+/**
+ * A class to open paths in new browser tabs in the Notebook application.
+ */
+class DefaultNotebookPathOpener {
+    /**
+     * Open a path in a new browser tab.
+     */
+    open(options) {
+        const { prefix, path, searchParams, target, features } = options;
+        const url = new URL(URLExt.join(prefix, path !== null && path !== void 0 ? path : ''), window.location.origin);
+        if (searchParams) {
+            url.search = searchParams.toString();
+        }
+        return window.open(url, target, features);
+    }
+}
+export const defaultNotebookPathOpener = new DefaultNotebookPathOpener();

package/lib/tokens.d.ts

@@ -0,0 +1,48 @@
+import { Token } from '@lumino/coreutils';
+/**
+ * The INotebookPathOpener interface.
+ */
+export interface INotebookPathOpener {
+    /**
+     * Open a path in the application.
+     *
+     * @param options - The options used to open the path.
+     */
+    open: (options: INotebookPathOpener.IOpenOptions) => WindowProxy | null;
+}
+export declare namespace INotebookPathOpener {
+    /**
+     * The options used to open a path in the application.
+     */
+    interface IOpenOptions {
+        /**
+         * The URL prefix, which should include the base URL
+         */
+        prefix: string;
+        /**
+         * The path to open in the application, e.g `setup.py`, or `notebooks/example.ipynb`
+         */
+        path?: string;
+        /**
+         * The extra search params to use in the URL.
+         */
+        searchParams?: URLSearchParams;
+        /**
+         * Name of the browsing context the resource is being loaded into.
+         * See https://developer.mozilla.org/en-US/docs/Web/API/Window/open for more details.
+         */
+        target?: string;
+        /**
+         *
+         * See https://developer.mozilla.org/en-US/docs/Web/API/Window/open for more details.
+         */
+        features?: string;
+    }
+}
+/**
+ * The INotebookPathOpener token.
+ * The main purpose of this token is to allow other extensions or downstream applications
+ * to override the default behavior of opening a notebook in a new tab.
+ * It also allows passing the path as a URL search parameter, or other options to the window.open call.
+ */
+export declare const INotebookPathOpener: Token<INotebookPathOpener>;

package/lib/tokens.js

@@ -0,0 +1,8 @@
+import { Token } from '@lumino/coreutils';
+/**
+ * The INotebookPathOpener token.
+ * The main purpose of this token is to allow other extensions or downstream applications
+ * to override the default behavior of opening a notebook in a new tab.
+ * It also allows passing the path as a URL search parameter, or other options to the window.open call.
+ */
+export const INotebookPathOpener = new Token('@jupyter-notebook/application:INotebookPathOpener');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyter-notebook/application",
-  "version": "7.0.3",
+  "version": "7.0.5",
   "description": "Jupyter Notebook - Application",
   "homepage": "https://github.com/jupyter/notebook",
   "bugs": {
@@ -42,11 +42,11 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/application": "^4.0.5",
-    "@jupyterlab/coreutils": "^6.0.5",
-    "@jupyterlab/docregistry": "^4.0.5",
-    "@jupyterlab/rendermime-interfaces": "^3.8.5",
-    "@jupyterlab/ui-components": "^4.0.5",
+    "@jupyterlab/application": "^4.0.7",
+    "@jupyterlab/coreutils": "^6.0.7",
+    "@jupyterlab/docregistry": "^4.0.7",
+    "@jupyterlab/rendermime-interfaces": "^3.8.7",
+    "@jupyterlab/ui-components": "^4.0.7",
     "@lumino/algorithm": "^2.0.1",
     "@lumino/coreutils": "^2.1.2",
     "@lumino/messaging": "^2.0.1",
@@ -57,7 +57,7 @@
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.12.1",
-    "@jupyterlab/testutils": "^4.0.5",
+    "@jupyterlab/testutils": "^4.0.7",
     "@types/jest": "^29.2.5",
     "jest": "^29.3.1",
     "rimraf": "^3.0.2",