@datalayer/jupyter-react 0.19.3 → 0.19.4

package/lib/components/console/Console.js

@@ -11,20 +11,20 @@ import ConsoleAdapter from './ConsoleAdapter';
 import useConsoleStore from './ConsoleState';
 import './Console.css';
 export const Console = (options) => {
-    const { defaultKernel, defaultKernelIsLoading, serviceManager } = useJupyter();
+    const { defaultKernel, serviceManager } = useJupyter();
     const [adapter, setAdapter] = useState();
-    const consoleStore = useConsoleStore();
+    const store = useConsoleStore();
     useEffect(() => {
-        if (serviceManager && !defaultKernelIsLoading) {
+        if (serviceManager) {
             const adapter = new ConsoleAdapter({
                 kernel: defaultKernel,
                 serviceManager,
                 code: options.code,
             });
             setAdapter(adapter);
-            consoleStore.setAdapter(adapter);
+            store.setAdapter(adapter);
         }
-    }, [defaultKernel, defaultKernelIsLoading, serviceManager]);
+    }, [defaultKernel, serviceManager]);
     return adapter ? (_jsx(Lumino, { children: adapter.panel })) : (_jsx(_Fragment, { children: "Loading Jupyter Console..." }));
 };
 export default Console;

package/lib/components/console/Console.js.map

@@ -1 +1 @@
-{"version":3,"file":"Console.js","sourceRoot":"","sources":["../../../src/components/console/Console.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,eAAe,MAAM,gBAAgB,CAAC;AAE7C,OAAO,eAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAgC,EAAE,EAAE;IAC1D,MAAM,EAAE,aAAa,EAAE,sBAAsB,EAAE,cAAc,EAAE,GAC7D,UAAU,EAAE,CAAC;IACf,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,EAAkB,CAAC;IACzD,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;IACvC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,cAAc,IAAI,CAAC,sBAAsB,EAAE;YAC7C,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;gBACjC,MAAM,EAAE,aAAa;gBACrB,cAAc;gBACd,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;YACH,UAAU,CAAC,OAAO,CAAC,CAAC;YACpB,YAAY,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SAClC;IACH,CAAC,EAAE,CAAC,aAAa,EAAE,sBAAsB,EAAE,cAAc,CAAC,CAAC,CAAC;IAC5D,OAAO,OAAO,CAAC,CAAC,CAAC,CACf,KAAC,MAAM,cAAE,OAAO,CAAC,KAAK,GAAU,CACjC,CAAC,CAAC,CAAC,CACF,2DAA+B,CAChC,CAAC;AACJ,CAAC,CAAC;AAcF,eAAe,OAAO,CAAC"}
+{"version":3,"file":"Console.js","sourceRoot":"","sources":["../../../src/components/console/Console.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,MAAM,MAAM,kBAAkB,CAAC;AACtC,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAC9C,OAAO,eAAe,MAAM,gBAAgB,CAAC;AAE7C,OAAO,eAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,OAAgC,EAAE,EAAE;IAC1D,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,UAAU,EAAE,CAAC;IACvD,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,EAAkB,CAAC;IACzD,MAAM,KAAK,GAAG,eAAe,EAAE,CAAC;IAChC,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,cAAc,EAAE;YAClB,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC;gBACjC,MAAM,EAAE,aAAa;gBACrB,cAAc;gBACd,IAAI,EAAE,OAAO,CAAC,IAAI;aACnB,CAAC,CAAC;YACH,UAAU,CAAC,OAAO,CAAC,CAAC;YACpB,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;SAC3B;IACH,CAAC,EAAE,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC,CAAC;IACpC,OAAO,OAAO,CAAC,CAAC,CAAC,CACf,KAAC,MAAM,cAAE,OAAO,CAAC,KAAK,GAAU,CACjC,CAAC,CAAC,CAAC,CACF,2DAA+B,CAChC,CAAC;AACJ,CAAC,CAAC;AAcF,eAAe,OAAO,CAAC"}

package/lib/components/notebook/BaseNotebook.d.ts

@@ -0,0 +1,148 @@
+/// <reference types="react" />
+import type { INotebookContent } from '@jupyterlab/nbformat';
+import { NotebookModel } from '@jupyterlab/notebook';
+import type { Kernel, ServerConnection, ServiceManager } from '@jupyterlab/services';
+import { CommandRegistry } from '@lumino/commands';
+import type { OnSessionConnection } from '../../state';
+import { type ICellSidebarProps } from './cell';
+import type { DatalayerNotebookExtension } from './Notebook';
+/**
+ * Base notebook component properties
+ */
+export interface IBaseNotebookProps {
+    CellSidebar?: (props: ICellSidebarProps) => JSX.Element;
+    /**
+     * Custom command registry.
+     *
+     * Note:
+     * Providing it allows to command the component from an higher level.
+     */
+    commandRegistry?: CommandRegistry;
+    /**
+     * Notebook ID
+     */
+    id?: string;
+    /**
+     * Notebook extensions
+     */
+    extensions?: DatalayerNotebookExtension[];
+    /**
+     * Kernel ID to connect to
+     */
+    kernelId?: string;
+    /**
+     * Service manager
+     */
+    serviceManager: ServiceManager.IManager;
+    /**
+     * Notebook content model
+     */
+    model: NotebookModel;
+    /**
+     * Whether nbgrader mode is activated or not.
+     */
+    nbgrader: boolean;
+    /**
+     * Callback on session connection changed
+     */
+    onSessionConnectionChanged?: OnSessionConnection;
+    /**
+     * Notebook path
+     *
+     * Set this only if you use Jupyter Server to fetch
+     * and save the content.
+     */
+    path?: string;
+}
+/**
+ * Base notebook component
+ *
+ * The notebook model and kernel lifecycle is not handled by
+ * this component.
+ */
+export declare function BaseNotebook(props: IBaseNotebookProps): JSX.Element;
+/**
+ * Get the kernel ID to connect to.
+ *
+ * Steps:
+ * - Check the requested kernel ID exists
+ * - If no kernel found, start a new one if required
+ */
+export declare function useKernelId(options: {
+    /**
+     * Kernels manager
+     */
+    kernels: Kernel.IManager;
+    /**
+     * Kernel ID to connect to
+     *
+     * If the kernel does not exist and {@link startDefaultKernel} is `true`,
+     * another kernel will be started.
+     */
+    requestedKernelId?: string;
+    /**
+     * Whether or not to start a default kernel.
+     *
+     * Default: false
+     */
+    startDefaultKernel?: boolean;
+}): string | undefined;
+export type CollaborationServer = {
+    /**
+     * Base server URL
+     */
+    baseURL: string;
+    /**
+     * Notebook room name to connect to.
+     */
+    roomName: string;
+    /**
+     * JWT token
+     */
+    token: string;
+    /**
+     * Server type
+     */
+    type: 'datalayer';
+} | {
+    /**
+     * Notebook path
+     */
+    path: string;
+    /**
+     * Jupyter server settings
+     */
+    serverSettings: ServerConnection.ISettings;
+    /**
+     * Server type
+     */
+    type: 'jupyter';
+};
+/**
+ * Hook to handle a notebook model.
+ *
+ * The notebook content may come from 3 sources:
+ * - {@link nbformat}: The notebook content
+ * - {@link url}: A URL to fetch the notebook content from
+ * - {@link collaborationServer}: Parameters to connect to a collaboration server
+ */
+export declare function useNotebookModel(options: {
+    /**
+     * Collaboration server providing the document rooms
+     */
+    collaborationServer?: CollaborationServer;
+    /**
+     * Notebook content.
+     */
+    nbformat?: INotebookContent;
+    /**
+     * Whether the model is read-only or not.
+     *
+     * Default: false
+     */
+    readonly?: boolean;
+    /**
+     * URL to fetch the notebook content from.
+     */
+    url?: string;
+}): NotebookModel | null;