@oceanum/oceanumlab 4.6.2 → 4.7.1

package/lib/index.js

@@ -2,6 +2,7 @@ import { ILayoutRestorer, ILabStatus } from '@jupyterlab/application';
 import { ICommandPalette, Notification } from '@jupyterlab/apputils';
 import { LabIcon } from '@jupyterlab/ui-components';
 import { find } from '@lumino/algorithm';
+import { Signal } from '@lumino/signaling';
 import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import { IStateDB } from '@jupyterlab/statedb';
 import { INotebookTracker } from '@jupyterlab/notebook';
@@ -11,11 +12,13 @@ import { requestAPI } from './handler';
 import { ChatRouter, ChatRouterError } from './chatRouter';
 import { reporterFor } from './progress';
 import { ConversationPin } from './conversationPin';
+import { deviceAuthPlugin } from './auth/plugin';
+import { IOceanumAuth } from './auth/tokens';
 import { snapshotFromIpynb, snapshotOf } from './notebookContext';
 import { notebookHost } from './notebookHost';
 import { KernelHandoff } from './kernelHandoff';
 import { runChatLoop, STOPPED } from './aiLoop';
-import { DATAMESH_UI_SERVICE, MAX_OBSERVE_ROUNDS } from './constants';
+import { DATAMESH_UI_SERVICE, MAX_OBSERVE_ROUNDS, OCEANUM_AI_BACKEND_URL } from './constants';
 import '../style/index.css';
 import oceanumSvg from '../style/icons/oceanum.svg';
 // Theme-adaptive icon using currentColor (auto-adapts to light/dark themes)
@@ -37,10 +40,22 @@ export const datamesh_connect_extension = {
         ISettingRegistry,
         IStateDB
     ],
-    activate: (app, palette, restorer, status, settingRegistry) => {
+    // Optional so the panel still loads on a host with no Oceanum environment; the
+    // Notebooks tab then explains why it is empty instead of the panel failing to start.
+    optional: [IOceanumAuth],
+    activate: (app, palette, restorer, status, settingRegistry, stateDB, auth) => {
+        var _a, _b, _c, _d;
         console.log('Oceanum datamesh connect extension is loaded');
-        // The `datameshUiUrl` setting; the default until the settings load.
-        let datameshUiUrl = DATAMESH_UI_SERVICE;
+        // Where the Datamesh UI and Oceanum AI live is the deployment's business, so it comes
+        // from the sign-in environment (the Jupyter server's configuration, or the notebook
+        // site's) and falls back to production. These were user settings until 4.7.1; a
+        // user-editable service address is somewhere to send the user's credential.
+        const datameshUiUrl = (_b = (_a = auth === null || auth === void 0 ? void 0 : auth.urls) === null || _a === void 0 ? void 0 : _a.datameshUi) !== null && _b !== void 0 ? _b : DATAMESH_UI_SERVICE;
+        const aiBackendUrl = (_d = (_c = auth === null || auth === void 0 ? void 0 : auth.urls) === null || _c === void 0 ? void 0 : _c.ai) !== null && _d !== void 0 ? _d : OCEANUM_AI_BACKEND_URL;
+        // The `datameshToken` setting for the AI chat; empty until the settings load.
+        let datameshTokenSetting = '';
+        // Tells the sidebar the settings above have changed.
+        const settingsChanged = new Signal(app);
         const findDatameshUI = () => find(app.shell.widgets('main'), (widget) => widget.id === 'datamesh-ui');
         //Try to get the datamesh token from the settings
         const updateSettings = (set) => {
@@ -53,12 +68,8 @@ export const datamesh_connect_extension = {
                 }).then(res => console.log(res));
             }
             window.injectToken = set.get('injectToken').user;
-            // An open Datamesh UI panel follows a change of address.
-            datameshUiUrl = set.get('datameshUiUrl').composite;
-            const datameshUI = findDatameshUI();
-            if (datameshUI) {
-                datameshUI.url = datameshUiUrl;
-            }
+            datameshTokenSetting = set.get('datameshToken').composite;
+            settingsChanged.emit();
         };
         //Try to get the datamesh token from the envars
         Promise.all([app.restored, settingRegistry.load(PLUGIN_ID)])
@@ -95,15 +106,45 @@ export const datamesh_connect_extension = {
             openDatameshUI: openDatameshUI,
             datameshUiUrl: () => datameshUiUrl,
             datameshUiFrame: () => { var _a, _b; return (_b = (_a = findDatameshUI()) === null || _a === void 0 ? void 0 : _a.frame) !== null && _b !== void 0 ? _b : null; },
+            datameshToken: () => datameshTokenSetting,
+            aiBackendUrl: () => aiBackendUrl,
+            settingsChanged,
             commands: app.commands,
-            getCurrentWidget
+            getCurrentWidget,
+            auth
+            // No `openStoredNotebook`: nothing can open a spec store record by id yet.
+            // share-oceanum has `oceanum-share:open`, but it takes no arguments — it opens
+            // its own picker — so there is nothing to hand an id to. Opening arrives with
+            // the drive in OCE-182, where the contents API makes it the ordinary path.
+            // Until then the list reads rather than offering a click that does nothing.
         });
         datameshConnectWidget.id = 'datamesh-connect';
         datameshConnectWidget.title.icon = oceanumIcon;
         datameshConnectWidget.title.caption = 'Datamesh Connect';
         restorer.add(datameshConnectWidget, 'datamesh-connect');
+        // The layout restorer restores the widget's place in the shell, not fields on it,
+        // so the chosen tab is kept here. Restoring is best effort: a missing or unreadable
+        // entry just leaves the default.
+        const TAB_STATE_KEY = `${PLUGIN_ID}:tab`;
+        void stateDB
+            .fetch(TAB_STATE_KEY)
+            .then(value => {
+            if (typeof value === 'string') {
+                datameshConnectWidget.selectTab(value);
+            }
+        })
+            .catch(() => undefined);
+        datameshConnectWidget.tabChanged.connect((_, id) => {
+            void stateDB.save(TAB_STATE_KEY, id);
+        });
         // Rank has been chosen somewhat arbitrarily to give priority to the running
         // sessions widget in the sidebar.
+        //
+        // Oceanum Notebook wants this panel first instead, but that is a property of that
+        // distribution rather than of the extension: in a plain JupyterLab the file browser
+        // is the primary navigation surface and displacing it would be a regression. A
+        // distribution moves it with JupyterLab's own shell user-layout settings, keyed on
+        // this widget's id, rather than this extension hard-coding one host's preference.
         app.shell.add(datameshConnectWidget, 'left', { rank: 900 });
         app.commands.addCommand('datamesh-ui:open', {
             execute: (args) => {
@@ -121,7 +162,8 @@ export const oceanum_ai_extension = {
     id: '@oceanum/oceanumlab:ai-chat',
     autoStart: true,
     requires: [INotebookTracker, ISettingRegistry],
-    activate: (app, notebookTracker, settingRegistry) => {
+    optional: [IOceanumAuth],
+    activate: (app, notebookTracker, settingRegistry, auth) => {
         console.log('Oceanum AI chat extension is loaded');
         const SETTINGS_ID = '@oceanum/oceanumlab:datamesh-connect';
         settingRegistry
@@ -137,7 +179,7 @@ export const oceanum_ai_extension = {
             // The panel the current request read its selected cell from, if the
             // notebook was open: a code answer may replace that cell only there.
             let readFrom = null;
-            const router = new ChatRouter(settings, async () => {
+            const router = new ChatRouter(settings, app.commands, async () => {
                 const open = await pin.current();
                 readFrom = open;
                 if (open) {
@@ -157,7 +199,7 @@ export const oceanum_ai_extension = {
                     // Gone: an answer's cells will go into a new notebook instead.
                     return null;
                 }
-            });
+            }, () => { var _a, _b; return (_b = (_a = auth === null || auth === void 0 ? void 0 : auth.urls) === null || _a === void 0 ? void 0 : _a.ai) !== null && _b !== void 0 ? _b : ''; });
             // Asked only when an answer has blocks to place: brings the
             // conversation's notebook to the front, opening it again if closed.
             const handoff = new KernelHandoff(() => pin.show(), () => readFrom);
@@ -277,4 +319,14 @@ export const oceanum_ai_extension = {
         });
     }
 };
-export default [datamesh_connect_extension, oceanum_ai_extension];
+/**
+ * The sign-in contract, exported so another extension can provide or consume it: a Lumino
+ * token is matched by object identity, so everyone has to import this one object, and
+ * JupyterLab shares `@oceanum/oceanumlab` between extensions as a singleton module.
+ */
+export * from './auth/tokens';
+export default [
+    deviceAuthPlugin,
+    datamesh_connect_extension,
+    oceanum_ai_extension
+];

package/lib/specStore.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Reading the Oceanum spec store's `notebook` records.
+ *
+ * Deliberately small: only what the Stored notebooks tab needs. oceanum-notebook's
+ * share-oceanum package has a fuller client (create, update, permissions), and when
+ * sharing moves here the two should become one rather than sitting side by side.
+ */
+/** A spec store list entry. The list omits the notebook body. */
+export interface ISpecSummary {
+    id: string;
+    name: string;
+    description: string | null;
+    /** Set when the record is created and never updated, so this is a creation time. */
+    modified: string;
+    /** Null unless the caller created the record: the store hides other creators. */
+    creator: string | null;
+}
+/**
+ * Every notebook the signed-in user may read: their own and those shared with them.
+ *
+ * The store answers an unauthenticated caller with an empty list rather than an error,
+ * so a missing token is indistinguishable from an empty account — callers should check
+ * they are signed in before showing "no notebooks".
+ */
+export declare function listNotebooks(specsUrl: string, token: string, fetcher?: typeof fetch): Promise<ISpecSummary[]>;
+/**
+ * Split a listing into the caller's own notebooks and the rest, newest first.
+ *
+ * The store only sends `creator` on records the caller created, so anything else it
+ * returns is shared with them — directly, or because it is public. Addresses are
+ * compared case-insensitively: the store matches entities as case-sensitive globs, so
+ * the two sides can differ in case.
+ */
+export declare function partitionNotebooks(items: readonly ISpecSummary[], email: string | null): {
+    mine: ISpecSummary[];
+    shared: ISpecSummary[];
+};

package/lib/specStore.js

@@ -0,0 +1,57 @@
+/**
+ * Reading the Oceanum spec store's `notebook` records.
+ *
+ * Deliberately small: only what the Stored notebooks tab needs. oceanum-notebook's
+ * share-oceanum package has a fuller client (create, update, permissions), and when
+ * sharing moves here the two should become one rather than sitting side by side.
+ */
+function isSummary(value) {
+    if (typeof value !== 'object' || value === null) {
+        return false;
+    }
+    const v = value;
+    return (typeof v.id === 'string' &&
+        typeof v.name === 'string' &&
+        typeof v.modified === 'string');
+}
+/**
+ * Every notebook the signed-in user may read: their own and those shared with them.
+ *
+ * The store answers an unauthenticated caller with an empty list rather than an error,
+ * so a missing token is indistinguishable from an empty account — callers should check
+ * they are signed in before showing "no notebooks".
+ */
+export async function listNotebooks(specsUrl, token, fetcher = fetch) {
+    const url = `${specsUrl.replace(/\/+$/, '')}/specs/notebook`;
+    const response = await fetcher(url, {
+        headers: { Authorization: `Bearer ${token}` }
+    });
+    if (!response.ok) {
+        // The store answers a bad or expired token with 400, and 403 both for no access
+        // and for a record that does not exist.
+        throw new Error(`Oceanum.io returned HTTP ${response.status}.`);
+    }
+    const data = await response.json();
+    if (!Array.isArray(data)) {
+        throw new Error('Oceanum.io returned an unexpected response.');
+    }
+    return data.filter(isSummary);
+}
+/**
+ * Split a listing into the caller's own notebooks and the rest, newest first.
+ *
+ * The store only sends `creator` on records the caller created, so anything else it
+ * returns is shared with them — directly, or because it is public. Addresses are
+ * compared case-insensitively: the store matches entities as case-sensitive globs, so
+ * the two sides can differ in case.
+ */
+export function partitionNotebooks(items, email) {
+    var _a;
+    const me = (_a = email === null || email === void 0 ? void 0 : email.toLowerCase()) !== null && _a !== void 0 ? _a : null;
+    const sorted = [...items].sort((a, b) => b.modified.localeCompare(a.modified));
+    const isMine = (item) => { var _a; return me !== null && ((_a = item.creator) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === me; };
+    return {
+        mine: sorted.filter(isMine),
+        shared: sorted.filter(item => !isMine(item))
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@oceanum/oceanumlab",
-    "version": "4.6.2",
+    "version": "4.7.1",
     "description": "A Jupyterlab extension to interact with the Oceanum.io platform",
     "keywords": [
         "jupyter",
@@ -60,8 +60,16 @@
         "@jupyterlab/application": "^4.6.3",
         "@jupyterlab/apputils": "^4.7.3",
         "@jupyterlab/cells": "^4.6.3",
+        "@jupyterlab/console": "^4.6.3",
+        "@jupyterlab/coreutils": "^6.6.3",
         "@jupyterlab/notebook": "^4.6.3",
+        "@jupyterlab/services": "^7.6.3",
         "@jupyterlab/settingregistry": "^4.6.3",
+        "@lumino/commands": "^2.3.3",
+        "@lumino/coreutils": "^2.2.2",
+        "@lumino/disposable": "^2.1.5",
+        "@lumino/signaling": "^2.1.5",
+        "@lumino/widgets": "^2.8.0",
         "@phosphor-icons/react": "^2.1.10",
         "marked": "^18.0.13"
     },

package/schema/datamesh-connect.json

@@ -18,12 +18,6 @@
       "description": "Inject Datamesh token into code.",
       "default": false
     },
-    "datameshUiUrl": {
-      "type": "string",
-      "title": "Datamesh UI URL",
-      "description": "Address of the Datamesh UI shown in the Datamesh panel. Use the address it is finally served from: the panel only accepts workspace updates from this address's origin, so an address that redirects to another origin will not update the workspace.",
-      "default": "https://ui.datamesh.oceanum.io"
-    },
     "autoRunCode": {
       "type": "boolean",
       "title": "Auto-run code",
@@ -37,5 +31,8 @@
       "default": false
     }
   },
+  "patternProperties": {
+    "^(datameshUiUrl|aiBackendUrl)$": {}
+  },
   "additionalProperties": false
 }

package/src/DatameshUI.tsx

@@ -3,20 +3,11 @@ import { ReactWidget } from '@jupyterlab/apputils';
 import { datameshUiSrc } from './datameshUiUrl';
 
 export class DatameshUI extends ReactWidget {
-  /** `url` is the `datameshUiUrl` setting. */
+  /** `url` is the deployment's Datamesh UI address (the sign-in environment's). */
   constructor(private _url: string) {
     super();
   }
 
-  /**
-   * Point the panel at the `datameshUiUrl` setting's new value. The iframe
-   * reloads only if its address actually changes.
-   */
-  set url(url: string) {
-    this._url = url;
-    this.update();
-  }
-
   /** The iframe's window, for telling its messages apart; `null` if none. */
   get frame(): Window | null {
     return this.node.querySelector('iframe')?.contentWindow ?? null;