@datalayer/jupyter-react 0.19.3 → 0.19.5

package/lib/app/tabs/components/NotebookComponent.js

@@ -4,12 +4,13 @@ import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
  *
  * MIT License
  */
+import { CellSidebarExtension } from '../../../components';
 import Notebook from '../../../components/notebook/Notebook';
-import CellSidebarNew from './../../../components/notebook/cell/sidebar/CellSidebarButton';
 import nbformat from './../../..//examples/notebooks/NotebookExample1.ipynb.json';
+import CellSidebarNew from './../../../components/notebook/cell/sidebar/CellSidebarButton';
 export const NotebookComponent = () => {
     return (_jsx(_Fragment, { children: _jsx(Notebook, { startDefaultKernel: true, nbformat: nbformat, id: "notebook-id", cellSidebarMargin: 60, height: "calc(100vh - 2.6rem)" // (Height - Toolbar Height).
-            , CellSidebar: CellSidebarNew }) }));
+            , extensions: [new CellSidebarExtension({ factory: CellSidebarNew })] }) }));
 };
 export default NotebookComponent;
 //# sourceMappingURL=NotebookComponent.js.map

package/lib/app/tabs/components/NotebookComponent.js.map

@@ -1 +1 @@
-{"version":3,"file":"NotebookComponent.js","sourceRoot":"","sources":["../../../../src/app/tabs/components/NotebookComponent.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAO,QAAQ,MAAM,uCAAuC,CAAC;AAC7D,OAAO,cAAc,MAAM,+DAA+D,CAAC;AAE3F,OAAO,QAAQ,MAAM,4DAA4D,CAAC;AAElF,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,OAAO,CACL,4BACE,KAAC,QAAQ,IACP,kBAAkB,EAAE,IAAI,EACxB,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAC,aAAa,EAChB,iBAAiB,EAAE,EAAE,EACrB,MAAM,EAAC,sBAAsB,CAAC,6BAA6B;cAC3D,WAAW,EAAE,cAAc,GAC3B,GACD,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}
+{"version":3,"file":"NotebookComponent.js","sourceRoot":"","sources":["../../../../src/app/tabs/components/NotebookComponent.tsx"],"names":[],"mappings":";AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,QAAQ,MAAM,uCAAuC,CAAC;AAC7D,OAAO,QAAQ,MAAM,4DAA4D,CAAC;AAClF,OAAO,cAAc,MAAM,+DAA+D,CAAC;AAE3F,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,EAAE;IACpC,OAAO,CACL,4BACE,KAAC,QAAQ,IACP,kBAAkB,EAAE,IAAI,EACxB,QAAQ,EAAE,QAAQ,EAClB,EAAE,EAAC,aAAa,EAChB,iBAAiB,EAAE,EAAE,EACrB,MAAM,EAAC,sBAAsB,CAAC,6BAA6B;cAC3D,UAAU,EAAE,CAAC,IAAI,oBAAoB,CAAC,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC,GACnE,GACD,CACJ,CAAC;AACJ,CAAC,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/lib/components/cell/CellCommands.d.ts

@@ -2,5 +2,5 @@ import { CommandRegistry } from '@lumino/commands';
 import { CompletionHandler } from '@jupyterlab/completer';
 import { CodeCell, MarkdownCell, RawCell } from '@jupyterlab/cells';
 import CellAdapter from './CellAdapter';
-export declare const CellCommands: (commandRegistry: CommandRegistry, cell: CodeCell | MarkdownCell | RawCell, completerHandler: CompletionHandler, cellAdapter: CellAdapter) => void;
+export declare const CellCommands: (commands: CommandRegistry, cell: CodeCell | MarkdownCell | RawCell, completerHandler: CompletionHandler, cellAdapter: CellAdapter) => void;
 export default CellCommands;

package/lib/components/cell/CellCommands.js

@@ -8,16 +8,16 @@ const cmdIds = {
     invoke: 'completer:invoke',
     select: 'completer:select',
 };
-export const CellCommands = (commandRegistry, cell, completerHandler, cellAdapter) => {
-    commandRegistry.addCommand(cmdIds.invoke, {
+export const CellCommands = (commands, cell, completerHandler, cellAdapter) => {
+    commands.addCommand(cmdIds.invoke, {
         label: 'Completer: Invoke',
         execute: () => completerHandler.invoke(),
     });
-    commandRegistry.addCommand(cmdIds.select, {
+    commands.addCommand(cmdIds.select, {
         label: 'Completer: Select',
         execute: () => completerHandler.completer.selectActive(),
     });
-    commandRegistry.addCommand('run:cell', {
+    commands.addCommand('run:cell', {
         execute: () => {
             if (cell instanceof CodeCell) {
                 cellAdapter.execute();
@@ -27,12 +27,12 @@ export const CellCommands = (commandRegistry, cell, completerHandler, cellAdapte
             }
         },
     });
-    commandRegistry.addKeyBinding({
+    commands.addKeyBinding({
         selector: '.jp-InputArea-editor.jp-mod-completer-enabled',
         keys: ['Tab'],
         command: cmdIds.invoke,
     });
-    commandRegistry.addKeyBinding({
+    commands.addKeyBinding({
         selector: '.jp-InputArea-editor',
         keys: ['Shift Enter'],
         command: 'run:cell',
@@ -44,7 +44,7 @@ export const CellCommands = (commandRegistry, cell, completerHandler, cellAdapte
             command: cmdIds.select,
         },
     ];
-    bindings.map(binding => commandRegistry.addKeyBinding(binding));
+    bindings.map(binding => commands.addKeyBinding(binding));
 };
 export default CellCommands;
 //# sourceMappingURL=CellCommands.js.map

package/lib/components/cell/CellCommands.js.map

@@ -1 +1 @@
-{"version":3,"file":"CellCommands.js","sourceRoot":"","sources":["../../../src/components/cell/CellCommands.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAW,MAAM,mBAAmB,CAAC;AAGpE,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,kBAAkB;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,eAAgC,EAChC,IAAuC,EACvC,gBAAmC,EACnC,WAAwB,EAClB,EAAE;IACR,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE;QACxC,KAAK,EAAE,mBAAmB;QAC1B,OAAO,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE;KACzC,CAAC,CAAC;IACH,eAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE;QACxC,KAAK,EAAE,mBAAmB;QAC1B,OAAO,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,YAAY,EAAE;KACzD,CAAC,CAAC;IACH,eAAe,CAAC,UAAU,CAAC,UAAU,EAAE;QACrC,OAAO,EAAE,GAAG,EAAE;YACZ,IAAI,IAAI,YAAY,QAAQ,EAAE;gBAC5B,WAAW,CAAC,OAAO,EAAE,CAAC;aACvB;iBAAM,IAAI,IAAI,YAAY,YAAY,EAAE;gBACtC,IAAqB,CAAC,QAAQ,GAAG,IAAI,CAAC;aACxC;QACH,CAAC;KACF,CAAC,CAAC;IACH,eAAe,CAAC,aAAa,CAAC;QAC5B,QAAQ,EAAE,+CAA+C;QACzD,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,OAAO,EAAE,MAAM,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,eAAe,CAAC,aAAa,CAAC;QAC5B,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,CAAC,aAAa,CAAC;QACrB,OAAO,EAAE,UAAU;KACpB,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG;QACf;YACE,QAAQ,EAAE,8CAA8C;YACxD,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KACF,CAAC;IACF,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;AAClE,CAAC,CAAC;AAEF,eAAe,YAAY,CAAC"}
+{"version":3,"file":"CellCommands.js","sourceRoot":"","sources":["../../../src/components/cell/CellCommands.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAW,MAAM,mBAAmB,CAAC;AAGpE,MAAM,MAAM,GAAG;IACb,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,kBAAkB;CAC3B,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,QAAyB,EACzB,IAAuC,EACvC,gBAAmC,EACnC,WAAwB,EAClB,EAAE;IACR,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE;QACjC,KAAK,EAAE,mBAAmB;QAC1B,OAAO,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,MAAM,EAAE;KACzC,CAAC,CAAC;IACH,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,EAAE;QACjC,KAAK,EAAE,mBAAmB;QAC1B,OAAO,EAAE,GAAG,EAAE,CAAC,gBAAgB,CAAC,SAAS,CAAC,YAAY,EAAE;KACzD,CAAC,CAAC;IACH,QAAQ,CAAC,UAAU,CAAC,UAAU,EAAE;QAC9B,OAAO,EAAE,GAAG,EAAE;YACZ,IAAI,IAAI,YAAY,QAAQ,EAAE;gBAC5B,WAAW,CAAC,OAAO,EAAE,CAAC;aACvB;iBAAM,IAAI,IAAI,YAAY,YAAY,EAAE;gBACtC,IAAqB,CAAC,QAAQ,GAAG,IAAI,CAAC;aACxC;QACH,CAAC;KACF,CAAC,CAAC;IACH,QAAQ,CAAC,aAAa,CAAC;QACrB,QAAQ,EAAE,+CAA+C;QACzD,IAAI,EAAE,CAAC,KAAK,CAAC;QACb,OAAO,EAAE,MAAM,CAAC,MAAM;KACvB,CAAC,CAAC;IACH,QAAQ,CAAC,aAAa,CAAC;QACrB,QAAQ,EAAE,sBAAsB;QAChC,IAAI,EAAE,CAAC,aAAa,CAAC;QACrB,OAAO,EAAE,UAAU;KACpB,CAAC,CAAC;IACH,MAAM,QAAQ,GAAG;QACf;YACE,QAAQ,EAAE,8CAA8C;YACxD,IAAI,EAAE,CAAC,OAAO,CAAC;YACf,OAAO,EAAE,MAAM,CAAC,MAAM;SACvB;KACF,CAAC;IACF,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,eAAe,YAAY,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 { DatalayerNotebookExtension } from './Notebook';
+/**
+ * Base notebook component properties
+ */
+export interface IBaseNotebookProps {
+    /**
+     * Custom command registry.
+     *
+     * Note:
+     * Providing it allows to command the component from an higher level.
+     */
+    commands?: 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;
+    /**
+     * 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.
+ *
+ * Important
+ * This component is not connected to any React stores.
+ */
+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
+ *
+ * Note
+ * If the hook starts the kernel, it will shut it down when unmounting.
+ */
+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;