jupyter-specta 0.3.5 → 0.4.0

package/README.md

@@ -52,6 +52,8 @@ jupyter lite build
 
 Then serve the contents of the output directory (by default `./_output`) using any static file server. You can access the `Specta` app at the `/specta/` path.
 
+If you want to disable specta loading spinner, you can set the environment variable `SPECTA_NO_LOADING_SCREEN` to `1`before calling jupyterlite build command
+
 ## Specta Configuration
 
 ### Available layouts

package/lib/document/plugin.d.ts

@@ -1,5 +1,6 @@
 import { ILabShell, JupyterFrontEndPlugin } from '@jupyterlab/application';
 import { IWidgetTracker } from '@jupyterlab/apputils';
-import { ISpectaShell } from '../token';
+import { ISpectaShell, ISpectaUrlFactory } from '../token';
 export declare const spectaDocument: JupyterFrontEndPlugin<IWidgetTracker, ISpectaShell>;
+export declare const spectaUrlFactory: JupyterFrontEndPlugin<ISpectaUrlFactory>;
 export declare const spectaOpener: JupyterFrontEndPlugin<void, ILabShell>;

package/lib/document/plugin.js

@@ -1,13 +1,13 @@
 import { IThemeManager, WidgetTracker } from '@jupyterlab/apputils';
 import { IEditorServices } from '@jupyterlab/codeeditor';
-import { PathExt } from '@jupyterlab/coreutils';
+import { PageConfig, PathExt, URLExt } from '@jupyterlab/coreutils';
 import { IDocumentManager } from '@jupyterlab/docmanager';
 import { IDefaultFileBrowser } from '@jupyterlab/filebrowser';
 import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { IKernelSpecManager } from '@jupyterlab/services';
 import { Widget } from '@lumino/widgets';
-import { ISpectaDocTracker, ISpectaLayoutRegistry } from '../token';
+import { ISpectaDocTracker, ISpectaLayoutRegistry, ISpectaUrlFactoryToken } from '../token';
 import { configLabLayout, createFileBrowser, hideAppLoadingIndicator, isSpectaApp, readSpectaConfig, registerDocumentFactory } from '../tool';
 const activate = (app, rendermime, tracker, editorServices, contentFactory, spectaLayoutRegistry, themeManager) => {
     const namespace = 'specta';
@@ -39,6 +39,29 @@ export const spectaDocument = {
     activate,
     provides: ISpectaDocTracker
 };
+export const spectaUrlFactory = {
+    id: 'specta/application-extension:urlFactory',
+    autoStart: true,
+    provides: ISpectaUrlFactoryToken,
+    activate() {
+        const urlFactory = (path) => {
+            const baseUrl = PageConfig.getBaseUrl();
+            let appUrl = PageConfig.getOption('appUrl');
+            if (!appUrl.endsWith('/')) {
+                appUrl = `${appUrl}/`;
+            }
+            const url = new URL(URLExt.join(baseUrl, appUrl));
+            url.searchParams.set('path', path);
+            const queries = PageConfig.getOption('query').split('&').filter(Boolean);
+            queries.forEach(query => {
+                const [key, value] = query.split('=');
+                url.searchParams.set(key, value);
+            });
+            return url.toString();
+        };
+        return urlFactory;
+    }
+};
 export const spectaOpener = {
     id: 'specta/application-extension:opener',
     autoStart: true,
@@ -48,7 +71,8 @@ export const spectaOpener = {
         ISpectaDocTracker,
         IKernelSpecManager
     ],
-    activate: async (app, docManager, defaultBrowser) => {
+    optional: [ISpectaUrlFactoryToken],
+    activate: async (app, docManager, defaultBrowser, tracker, kernelSpecManager, urlFactory) => {
         const urlParams = new URLSearchParams(window.location.search);
         if (!isSpectaApp()) {
             // Not a specta app
@@ -61,7 +85,6 @@ export const spectaOpener = {
                 if (PathExt.extname(path) === '.ipynb') {
                     const commands = app.commands;
                     const spectaConfig = readSpectaConfig({});
-                    console.log('spectaConfig', spectaConfig);
                     await configLabLayout({
                         config: spectaConfig.labConfig,
                         labShell,
@@ -79,7 +102,7 @@ export const spectaOpener = {
             //  Specta app
             const path = urlParams.get('path');
             if (!path) {
-                const browser = createFileBrowser({ defaultBrowser });
+                const browser = createFileBrowser({ defaultBrowser, urlFactory });
                 app.shell.add(browser, 'main', { rank: 100 });
                 hideAppLoadingIndicator();
             }

package/lib/extension_plugins.d.ts

@@ -1,4 +1,4 @@
 export * from './tool';
 export * from './token';
-declare const _default: (import("@jupyterlab/application").JupyterFrontEndPlugin<import("@jupyterlab/apputils").IWidgetTracker<import("@lumino/widgets").Widget>, import("./token").ISpectaShell> | import("@jupyterlab/application").JupyterFrontEndPlugin<void, import("@jupyterlab/application").ILabShell> | import("@jupyterlab/application").JupyterFrontEndPlugin<import("./token").ISpectaLayoutRegistry> | import("@jupyterlab/application").JupyterFrontEndPlugin<void, import("./token").ISpectaShell>)[];
+declare const _default: (import("@jupyterlab/application").JupyterFrontEndPlugin<import("@jupyterlab/apputils").IWidgetTracker<import("@lumino/widgets").Widget>, import("./token").ISpectaShell> | import("@jupyterlab/application").JupyterFrontEndPlugin<import("./token").ISpectaUrlFactory> | import("@jupyterlab/application").JupyterFrontEndPlugin<void, import("@jupyterlab/application").ILabShell> | import("@jupyterlab/application").JupyterFrontEndPlugin<import("./token").ISpectaLayoutRegistry> | import("@jupyterlab/application").JupyterFrontEndPlugin<void, import("./token").ISpectaShell>)[];
 export default _default;

package/lib/extension_plugins.js

@@ -1,4 +1,4 @@
-import { spectaDocument, spectaOpener } from './document/plugin';
+import { spectaDocument, spectaOpener, spectaUrlFactory } from './document/plugin';
 import { spectaLayoutRegistry } from './layout';
 import { appMeta, cellMeta } from './metadata';
 import { topbarPlugin } from './topbar';
@@ -10,5 +10,6 @@ export default [
     spectaLayoutRegistry,
     topbarPlugin,
     appMeta,
-    cellMeta
+    cellMeta,
+    spectaUrlFactory
 ];

package/lib/token.d.ts

@@ -64,5 +64,7 @@ export interface ISpectaCellConfig {
     showOutput?: boolean;
     outputSize?: 'Small' | 'Big' | 'Full';
 }
+export type ISpectaUrlFactory = (path: string) => string;
 export declare const ISpectaLayoutRegistry: Token<ISpectaLayoutRegistry>;
 export declare const ISpectaDocTracker: Token<IWidgetTracker<Widget>>;
+export declare const ISpectaUrlFactoryToken: Token<ISpectaUrlFactory>;

package/lib/token.js

@@ -1,3 +1,4 @@
 import { Token } from '@lumino/coreutils';
 export const ISpectaLayoutRegistry = new Token('specta:ISpectaLayoutRegistry');
 export const ISpectaDocTracker = new Token('exampleDocTracker');
+export const ISpectaUrlFactoryToken = new Token('specta:ISpectaUrlFactoryToken');

package/lib/tool.d.ts

@@ -6,7 +6,7 @@ import { ICell, INotebookMetadata } from '@jupyterlab/nbformat';
 import { INotebookTracker, NotebookPanel } from '@jupyterlab/notebook';
 import { IRenderMimeRegistry } from '@jupyterlab/rendermime';
 import { CommandRegistry } from '@lumino/commands';
-import { ISpectaAppConfig, ISpectaCellConfig, ISpectaLayoutRegistry, ISpectaShell } from './token';
+import { ISpectaAppConfig, ISpectaCellConfig, ISpectaLayoutRegistry, ISpectaShell, ISpectaUrlFactory } from './token';
 export declare function registerDocumentFactory(options: {
     factoryName: string;
     app: JupyterFrontEnd<ISpectaShell>;
@@ -20,6 +20,7 @@ export declare function registerDocumentFactory(options: {
 }): void;
 export declare function createFileBrowser(options: {
     defaultBrowser: IDefaultFileBrowser;
+    urlFactory: ISpectaUrlFactory | null;
 }): any;
 export declare function hideAppLoadingIndicator(): void;
 export declare function mergeObjects(...objects: Record<string, any>[]): Record<string, any>;

package/lib/tool.js

@@ -42,27 +42,31 @@ export function registerDocumentFactory(options) {
     });
 }
 export function createFileBrowser(options) {
-    const { defaultBrowser } = options;
+    const { defaultBrowser, urlFactory } = options;
     const browser = defaultBrowser;
     browser.singleClickNavigation = true;
     browser.showFileCheckboxes = false;
     browser.showLastModifiedColumn = false;
     browser.addClass('specta-file-browser');
-    const urlFactory = (path) => {
-        const baseUrl = PageConfig.getBaseUrl();
-        let appUrl = PageConfig.getOption('appUrl');
-        if (!appUrl.endsWith('/')) {
-            appUrl = `${appUrl}/`;
-        }
-        const url = new URL(URLExt.join(baseUrl, appUrl));
-        url.searchParams.set('path', path);
-        const queries = PageConfig.getOption('query').split('&').filter(Boolean);
-        queries.forEach(query => {
-            const [key, value] = query.split('=');
-            url.searchParams.set(key, value);
-        });
-        return url.toString();
-    };
+    const urlFactoryFn = urlFactory
+        ? urlFactory
+        : (path) => {
+            const baseUrl = PageConfig.getBaseUrl();
+            let appUrl = PageConfig.getOption('appUrl');
+            if (!appUrl.endsWith('/')) {
+                appUrl = `${appUrl}/`;
+            }
+            const url = new URL(URLExt.join(baseUrl, appUrl));
+            url.searchParams.set('path', path);
+            const queries = PageConfig.getOption('query')
+                .split('&')
+                .filter(Boolean);
+            queries.forEach(query => {
+                const [key, value] = query.split('=');
+                url.searchParams.set(key, value);
+            });
+            return url.toString();
+        };
     const oldHandler = browser.listing.handleOpen.bind(browser.listing);
     browser.listing.handleOpen = (item) => {
         if (item.type === 'directory') {
@@ -70,7 +74,7 @@ export function createFileBrowser(options) {
             return;
         }
         else {
-            window.open(urlFactory(item.path), '_blank');
+            window.open(urlFactoryFn(item.path), '_blank');
         }
     };
     return browser;
@@ -92,7 +96,6 @@ export function mergeObjects(...objects) {
     for (const obj of objects) {
         for (const [key, value] of Object.entries(obj)) {
             if (value !== null && value !== undefined) {
-                console.log('setting', key, value);
                 result[key] = value;
             }
         }

package/lib/topbar/widget.js

@@ -30,7 +30,6 @@ export function TopbarElement(props) {
         document.addEventListener('mousedown', handleClickOutside);
         return () => document.removeEventListener('mousedown', handleClickOutside);
     }, []);
-    console.log('config.background ', config.background);
     return (React.createElement("div", { className: "specta-topbar", style: { background: (_a = config.background) !== null && _a !== void 0 ? _a : 'var(--jp-layout-color1)' } },
         React.createElement("div", { className: "specta-topbar-left" },
             React.createElement("div", { className: "specta-topbar-icon-container" }, config.icon && React.createElement("img", { style: { height: '100%' }, src: config.icon })),

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "jupyter-specta",
-    "version": "0.3.5",
+    "version": "0.4.0",
     "description": "",
     "keywords": [],
     "homepage": "https://github.com/trungleduc/specta",
@@ -78,7 +78,7 @@
         "@jupyterlab/outputarea": "^4.5.0",
         "@jupyterlab/rendermime": "^4.5.0",
         "@jupyterlab/rendermime-extension": "^4.5.0",
-        "@jupyterlab/services": "^7.2.4",
+        "@jupyterlab/services": "^7.5.1",
         "@jupyterlab/services-extension": "^4.5.0",
         "@jupyterlab/settingeditor-extension": "^4.5.0",
         "@jupyterlab/settingregistry": "^4.5.0",