@jupyterlite/services 0.1.0 → 0.7.0-rc.1

package/lib/session/client.d.ts

@@ -0,0 +1,86 @@
+import type { Session } from '@jupyterlab/services';
+import { ServerConnection } from '@jupyterlab/services';
+import type { LiteKernelClient } from '../kernel';
+import type { ISessionAPIClient } from '@jupyterlab/services/lib/session/session';
+type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+/**
+ * A class to handle requests to /api/sessions
+ */
+export declare class LiteSessionClient implements ISessionAPIClient {
+    /**
+     * Construct a new LiteSessionClient.
+     *
+     * @param options The instantiation options for a LiteSessionClient.
+     */
+    constructor(options: LiteSessionClient.IOptions);
+    /**
+     * The server settings for the session client.
+     */
+    get serverSettings(): ServerConnection.ISettings;
+    /**
+     * Get a session by id.
+     *
+     * @param id The id of the session.
+     */
+    getModel(id: string): Promise<Session.IModel>;
+    /**
+     * List the running sessions
+     */
+    listRunning(): Promise<Session.IModel[]>;
+    /**
+     * Patch an existing session.
+     * This can be used to rename a session.
+     *
+     * - path updates session to track renamed paths
+     * - kernel.name starts a new kernel with a given kernelspec
+     *
+     * @param options The options to patch the session.
+     */
+    update(options: DeepPartial<Session.IModel>): Promise<Session.IModel>;
+    /**
+     * Start a new session
+     * TODO: read path and name
+     *
+     * @param options The options to start a new session.
+     */
+    startNew(options: Session.ISessionOptions): Promise<Session.IModel>;
+    /**
+     * Shut down a session.
+     *
+     * @param id The id of the session to shut down.
+     */
+    shutdown(id: string): Promise<void>;
+    /**
+     * Shut down all sessions.
+     */
+    shutdownAll(): Promise<void>;
+    /**
+     * Handle kernel shutdown
+     */
+    private _handleKernelShutdown;
+    private _kernelClient;
+    private _serverSettings;
+    private _sessions;
+    private _pendingRestarts;
+}
+/**
+ * A namespace for LiteSessionClient statics.
+ */
+export declare namespace LiteSessionClient {
+    /**
+     * The instantiation options for the session client.
+     */
+    interface IOptions {
+        /**
+         * A reference to the kernels service.
+         */
+        kernelClient: LiteKernelClient;
+        /**
+         * Server settings for the session client.
+         */
+        serverSettings?: ServerConnection.ISettings;
+    }
+}
+export {};

package/lib/session/client.js

@@ -0,0 +1,200 @@
+import { ServerConnection } from '@jupyterlab/services';
+import { PathExt } from '@jupyterlab/coreutils';
+import { ArrayExt } from '@lumino/algorithm';
+import { UUID } from '@lumino/coreutils';
+/**
+ * A class to handle requests to /api/sessions
+ */
+export class LiteSessionClient {
+    /**
+     * Construct a new LiteSessionClient.
+     *
+     * @param options The instantiation options for a LiteSessionClient.
+     */
+    constructor(options) {
+        var _a;
+        this._sessions = [];
+        this._pendingRestarts = new Set();
+        this._kernelClient = options.kernelClient;
+        this._serverSettings = (_a = options.serverSettings) !== null && _a !== void 0 ? _a : ServerConnection.makeSettings();
+        // Listen for kernel removals
+        this._kernelClient.changed.connect((_, args) => {
+            var _a, _b;
+            switch (args.type) {
+                case 'remove': {
+                    const kernelId = (_a = args.oldValue) === null || _a === void 0 ? void 0 : _a.id;
+                    if (!kernelId) {
+                        return;
+                    }
+                    // find the session associated with the kernel
+                    const session = this._sessions.find((s) => { var _a; return ((_a = s.kernel) === null || _a === void 0 ? void 0 : _a.id) === kernelId; });
+                    if (!session) {
+                        return;
+                    }
+                    // Track the kernel ID for restart detection
+                    this._pendingRestarts.add(kernelId);
+                    setTimeout(async () => {
+                        // If after a short delay the kernel hasn't been re-added, it was terminated
+                        if (this._pendingRestarts.has(kernelId)) {
+                            this._pendingRestarts.delete(kernelId);
+                            await this.shutdown(session.id);
+                        }
+                    }, 100);
+                    break;
+                }
+                case 'add': {
+                    // If this was a restart, remove it from pending
+                    const kernelId = (_b = args.newValue) === null || _b === void 0 ? void 0 : _b.id;
+                    if (!kernelId) {
+                        return;
+                    }
+                    this._pendingRestarts.delete(kernelId);
+                    break;
+                }
+            }
+        });
+    }
+    /**
+     * The server settings for the session client.
+     */
+    get serverSettings() {
+        return this._serverSettings;
+    }
+    /**
+     * Get a session by id.
+     *
+     * @param id The id of the session.
+     */
+    async getModel(id) {
+        const session = this._sessions.find((s) => s.id === id);
+        if (!session) {
+            throw Error(`Session ${id} not found`);
+        }
+        return session;
+    }
+    /**
+     * List the running sessions
+     */
+    async listRunning() {
+        return this._sessions;
+    }
+    /**
+     * Patch an existing session.
+     * This can be used to rename a session.
+     *
+     * - path updates session to track renamed paths
+     * - kernel.name starts a new kernel with a given kernelspec
+     *
+     * @param options The options to patch the session.
+     */
+    async update(options) {
+        const { id, path, name, kernel } = options;
+        const index = this._sessions.findIndex((s) => s.id === id);
+        const session = this._sessions[index];
+        if (!session) {
+            throw Error(`Session ${id} not found`);
+        }
+        const patched = {
+            ...session,
+            path: path !== null && path !== void 0 ? path : session.path,
+            name: name !== null && name !== void 0 ? name : session.name,
+        };
+        if (kernel) {
+            // Kernel id takes precedence over name.
+            if (kernel.id) {
+                const session = this._sessions.find((session) => { var _a; return ((_a = session.kernel) === null || _a === void 0 ? void 0 : _a.id) === (kernel === null || kernel === void 0 ? void 0 : kernel.id); });
+                if (session) {
+                    patched.kernel = session.kernel;
+                }
+            }
+            else if (kernel.name) {
+                const newKernel = await this._kernelClient.startNew({
+                    id: UUID.uuid4(),
+                    name: kernel.name,
+                    location: PathExt.dirname(patched.path),
+                });
+                if (newKernel) {
+                    patched.kernel = newKernel;
+                }
+                // clean up the session on kernel shutdown
+                void this._handleKernelShutdown({
+                    kernelId: newKernel.id,
+                    sessionId: session.id,
+                });
+            }
+        }
+        this._sessions[index] = patched;
+        return patched;
+    }
+    /**
+     * Start a new session
+     * TODO: read path and name
+     *
+     * @param options The options to start a new session.
+     */
+    async startNew(options) {
+        var _a, _b, _c;
+        const { path, name } = options;
+        const running = this._sessions.find((s) => s.name === name);
+        if (running) {
+            return running;
+        }
+        const kernelName = (_b = (_a = options.kernel) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : '';
+        const id = UUID.uuid4();
+        const nameOrPath = (_c = options.name) !== null && _c !== void 0 ? _c : options.path;
+        const dirname = PathExt.dirname(options.name) || PathExt.dirname(options.path);
+        const hasDrive = nameOrPath.includes(':');
+        const driveName = hasDrive ? nameOrPath.split(':')[0] : '';
+        // add drive name if missing (top level directory)
+        const location = dirname.includes(driveName) ? dirname : `${driveName}:${dirname}`;
+        const kernel = await this._kernelClient.startNew({
+            id,
+            name: kernelName,
+            location,
+        });
+        const session = {
+            id,
+            path,
+            name: name !== null && name !== void 0 ? name : path,
+            type: 'notebook',
+            kernel: {
+                id: kernel.id,
+                name: kernel.name,
+            },
+        };
+        this._sessions.push(session);
+        // clean up the session on kernel shutdown
+        void this._handleKernelShutdown({ kernelId: id, sessionId: session.id });
+        return session;
+    }
+    /**
+     * Shut down a session.
+     *
+     * @param id The id of the session to shut down.
+     */
+    async shutdown(id) {
+        var _a;
+        const session = this._sessions.find((s) => s.id === id);
+        if (!session) {
+            throw Error(`Session ${id} not found`);
+        }
+        const kernelId = (_a = session.kernel) === null || _a === void 0 ? void 0 : _a.id;
+        if (kernelId) {
+            await this._kernelClient.shutdown(kernelId);
+        }
+        ArrayExt.removeFirstOf(this._sessions, session);
+    }
+    /**
+     * Shut down all sessions.
+     */
+    async shutdownAll() {
+        await Promise.all(this._sessions.map((s) => this.shutdown(s.id)));
+    }
+    /**
+     * Handle kernel shutdown
+     */
+    async _handleKernelShutdown({ kernelId, sessionId, }) {
+        // No need to handle kernel shutdown here anymore since we're using the changed signal
+    }
+}
+//# sourceMappingURL=client.js.map

package/lib/session/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/session/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAIhD,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAE7C,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAQzC;;GAEG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;;;OAIG;IACH,YAAY,OAAmC;;QA2MvC,cAAS,GAAqB,EAAE,CAAC;QACjC,qBAAgB,GAAG,IAAI,GAAG,EAAU,CAAC;QA3M3C,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,eAAe,GAAG,MAAA,OAAO,CAAC,cAAc,mCAAI,gBAAgB,CAAC,YAAY,EAAE,CAAC;QACjF,6BAA6B;QAC7B,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE;;YAC7C,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,QAAQ,CAAC,CAAC,CAAC;oBACd,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,EAAE,CAAC;oBACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACd,OAAO;oBACT,CAAC;oBACD,8CAA8C;oBAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,WAAC,OAAA,CAAA,MAAA,CAAC,CAAC,MAAM,0CAAE,EAAE,MAAK,QAAQ,CAAA,EAAA,CAAC,CAAC;oBACtE,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,OAAO;oBACT,CAAC;oBACD,4CAA4C;oBAC5C,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;oBACpC,UAAU,CAAC,KAAK,IAAI,EAAE;wBACpB,4EAA4E;wBAC5E,IAAI,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;4BACxC,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;4BACvC,MAAM,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;wBAClC,CAAC;oBACH,CAAC,EAAE,GAAG,CAAC,CAAC;oBACR,MAAM;gBACR,CAAC;gBACD,KAAK,KAAK,CAAC,CAAC,CAAC;oBACX,gDAAgD;oBAChD,MAAM,QAAQ,GAAG,MAAA,IAAI,CAAC,QAAQ,0CAAE,EAAE,CAAC;oBACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACd,OAAO;oBACT,CAAC;oBACD,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;oBACvC,MAAM;gBACR,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACzC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CAAC,OAAoC;QAC/C,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,OAAO,GAAG;YACd,GAAG,OAAO;YACV,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,OAAO,CAAC,IAAI;YAC1B,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,OAAO,CAAC,IAAI;SAC3B,CAAC;QAEF,IAAI,MAAM,EAAE,CAAC;YACX,wCAAwC;YACxC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CACjC,CAAC,OAAO,EAAE,EAAE,WAAC,OAAA,CAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,EAAE,OAAK,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,EAAE,CAAA,CAAA,EAAA,CAC/C,CAAC;gBACF,IAAI,OAAO,EAAE,CAAC;oBACZ,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAClC,CAAC;YACH,CAAC;iBAAM,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBACvB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;oBAClD,EAAE,EAAE,IAAI,CAAC,KAAK,EAAE;oBAChB,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;iBACxC,CAAC,CAAC;gBAEH,IAAI,SAAS,EAAE,CAAC;oBACd,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;gBAC7B,CAAC;gBAED,0CAA0C;gBAC1C,KAAK,IAAI,CAAC,qBAAqB,CAAC;oBAC9B,QAAQ,EAAE,SAAS,CAAC,EAAE;oBACtB,SAAS,EAAE,OAAO,CAAC,EAAE;iBACtB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC;QAChC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAgC;;QAC7C,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;QAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAC5D,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,MAAM,UAAU,GAAG,MAAA,MAAA,OAAO,CAAC,MAAM,0CAAE,IAAI,mCAAI,EAAE,CAAC;QAC9C,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,UAAU,GAAG,MAAA,OAAO,CAAC,IAAI,mCAAI,OAAO,CAAC,IAAI,CAAC;QAChD,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,kDAAkD;QAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,EAAE,CAAC;QACnF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC;YAC/C,EAAE;YACF,IAAI,EAAE,UAAU;YAChB,QAAQ;SACT,CAAC,CAAC;QACH,MAAM,OAAO,GAAmB;YAC9B,EAAE;YACF,IAAI;YACJ,IAAI,EAAE,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,IAAI;YAClB,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE;gBACN,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB;SACF,CAAC;QACF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAE7B,0CAA0C;QAC1C,KAAK,IAAI,CAAC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC;QAEzE,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,EAAU;;QACvB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,KAAK,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;QACzC,CAAC;QACD,MAAM,QAAQ,GAAG,MAAA,OAAO,CAAC,MAAM,0CAAE,EAAE,CAAC;QACpC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC9C,CAAC;QACD,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW;QACf,MAAM,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,qBAAqB,CAAC,EAClC,QAAQ,EACR,SAAS,GAIV;QACC,sFAAsF;IACxF,CAAC;CAMF"}

package/lib/session/index.d.ts

@@ -0,0 +1 @@
+export * from './client';

package/lib/session/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './client';
+//# sourceMappingURL=index.js.map

package/lib/session/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/session/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,UAAU,CAAC"}

package/lib/settings/index.d.ts

@@ -0,0 +1 @@
+export * from './settings';

package/lib/settings/index.js

@@ -0,0 +1,4 @@
+// Copyright (c) Jupyter Development Team.
+// Distributed under the terms of the Modified BSD License.
+export * from './settings';
+//# sourceMappingURL=index.js.map

package/lib/settings/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/settings/index.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,2DAA2D;AAE3D,cAAc,YAAY,CAAC"}

package/lib/settings/settings.d.ts

@@ -0,0 +1,92 @@
+import type { ServerConnection, Setting } from '@jupyterlab/services';
+import { SettingManager } from '@jupyterlab/services';
+import type { ISettingRegistry } from '@jupyterlab/settingregistry';
+import type localforage from 'localforage';
+/**
+ * The settings file to request
+ */
+export type SettingsFile = 'all.json' | 'all_federated.json';
+/**
+ * A class to manage settings in the browser.
+ */
+export declare class Settings extends SettingManager implements Setting.IManager {
+    /**
+     * Create a new settings service.
+     */
+    constructor(options: Settings.IOptions);
+    /**
+     * A promise that resolves when the settings storage is fully initialized
+     */
+    get ready(): Promise<void>;
+    /**
+     * A lazy reference to initialized storage
+     */
+    protected get storage(): Promise<LocalForage>;
+    /**
+     * Finish any initialization after server has started and all extensions are applied.
+     */
+    initialize(): Promise<void>;
+    /**
+     * Prepare the storage
+     */
+    protected initStorage(): Promise<void>;
+    /**
+     * Get default options for localForage instances
+     */
+    protected get defaultStorageOptions(): LocalForageOptions;
+    /**
+     * Create a settings store.
+     */
+    protected defaultSettingsStorage(): LocalForage;
+    /**
+     * Get settings by plugin id
+     *
+     * @param pluginId the id of the plugin
+     *
+     */
+    fetch(pluginId: string): Promise<ISettingRegistry.IPlugin>;
+    /**
+     * Get all the settings
+     */
+    list(query?: 'ids'): Promise<{
+        ids: string[];
+        values: ISettingRegistry.IPlugin[];
+    }>;
+    /**
+     * Save settings for a given plugin id
+     *
+     * @param pluginId The id of the plugin
+     * @param raw The raw settings
+     *
+     */
+    save(id: string, raw: string): Promise<void>;
+    /**
+     * Clear all stored settings
+     *
+     * @returns A promise which resolves when the settings are cleared
+     */
+    clear(): Promise<void>;
+    /**
+     * Get all the settings for core or federated plugins
+     */
+    private _getAll;
+    private _storageName;
+    private _storageDrivers;
+    private _storage;
+    private _localforage;
+    private _ready;
+}
+/**
+ * A namespace for settings metadata.
+ */
+export declare namespace Settings {
+    /**
+     * Initialization options for settings.
+     */
+    interface IOptions {
+        localforage: typeof localforage;
+        storageName?: string | null;
+        storageDrivers?: string[] | null;
+        serverSettings?: ServerConnection.ISettings;
+    }
+}

package/lib/settings/settings.js

@@ -0,0 +1,185 @@
+import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { SettingManager } from '@jupyterlab/services';
+import { PromiseDelegate } from '@lumino/coreutils';
+import * as json5 from 'json5';
+/**
+ * The name of the local storage.
+ */
+const DEFAULT_STORAGE_NAME = 'JupyterLite Storage';
+/**
+ * A class to manage settings in the browser.
+ */
+export class Settings extends SettingManager {
+    /**
+     * Create a new settings service.
+     */
+    constructor(options) {
+        super({
+            serverSettings: options.serverSettings,
+        });
+        this._storageName = DEFAULT_STORAGE_NAME;
+        this._storageDrivers = null;
+        this._localforage = options.localforage;
+        this._storageName = options.storageName || DEFAULT_STORAGE_NAME;
+        this._storageDrivers = options.storageDrivers || null;
+        this._ready = new PromiseDelegate();
+        void this.initialize().catch(console.warn);
+    }
+    /**
+     * A promise that resolves when the settings storage is fully initialized
+     */
+    get ready() {
+        return this._ready.promise;
+    }
+    /**
+     * A lazy reference to initialized storage
+     */
+    get storage() {
+        return this.ready.then(() => this._storage);
+    }
+    /**
+     * Finish any initialization after server has started and all extensions are applied.
+     */
+    async initialize() {
+        await this.initStorage();
+        this._ready.resolve(void 0);
+    }
+    /**
+     * Prepare the storage
+     */
+    async initStorage() {
+        this._storage = this.defaultSettingsStorage();
+    }
+    /**
+     * Get default options for localForage instances
+     */
+    get defaultStorageOptions() {
+        var _a;
+        const driver = ((_a = this._storageDrivers) === null || _a === void 0 ? void 0 : _a.length) ? this._storageDrivers : null;
+        return {
+            version: 1,
+            name: this._storageName,
+            ...(driver ? { driver } : {}),
+        };
+    }
+    /**
+     * Create a settings store.
+     */
+    defaultSettingsStorage() {
+        return this._localforage.createInstance({
+            description: 'Offline Storage for Settings',
+            storeName: 'settings',
+            ...this.defaultStorageOptions,
+        });
+    }
+    /**
+     * Get settings by plugin id
+     *
+     * @param pluginId the id of the plugin
+     *
+     */
+    async fetch(pluginId) {
+        const all = await this.list();
+        const settings = all.values;
+        const setting = settings.find((setting) => {
+            return setting.id === pluginId;
+        });
+        if (!setting) {
+            throw new Error(`Setting ${pluginId} not found`);
+        }
+        return setting;
+    }
+    /**
+     * Get all the settings
+     */
+    async list(query) {
+        var _a, _b;
+        const allCore = await this._getAll('all.json');
+        let allFederated = [];
+        try {
+            allFederated = await this._getAll('all_federated.json');
+        }
+        catch {
+            // handle the case where there is no federated extension
+        }
+        // JupyterLab 4 expects all settings to be returned in one go
+        // so append the settings from federated plugins to the core ones
+        const all = allCore.concat(allFederated);
+        // return existing user settings if they exist
+        const storage = await this.storage;
+        const settings = await Promise.all(all.map(async (plugin) => {
+            var _a;
+            const { id } = plugin;
+            const raw = (_a = (await storage.getItem(id))) !== null && _a !== void 0 ? _a : plugin.raw;
+            return {
+                ...Private.override(plugin),
+                raw,
+                settings: json5.parse(raw),
+            };
+        }));
+        // format the settings
+        const ids = (_a = settings.map((plugin) => plugin.id)) !== null && _a !== void 0 ? _a : [];
+        let values = [];
+        if (!query) {
+            values =
+                (_b = settings.map((plugin) => {
+                    plugin.data = { composite: {}, user: {} };
+                    return plugin;
+                })) !== null && _b !== void 0 ? _b : [];
+        }
+        return { ids, values };
+    }
+    /**
+     * Save settings for a given plugin id
+     *
+     * @param pluginId The id of the plugin
+     * @param raw The raw settings
+     *
+     */
+    async save(id, raw) {
+        await (await this.storage).setItem(id, raw);
+    }
+    /**
+     * Clear all stored settings
+     *
+     * @returns A promise which resolves when the settings are cleared
+     */
+    async clear() {
+        await (await this.storage).clear();
+    }
+    /**
+     * Get all the settings for core or federated plugins
+     */
+    async _getAll(file) {
+        var _a;
+        const settingsUrl = (_a = PageConfig.getOption('settingsUrl')) !== null && _a !== void 0 ? _a : '/';
+        const all = (await (await fetch(URLExt.join(settingsUrl, file))).json());
+        return all;
+    }
+}
+/**
+ * A namespace for private data
+ */
+var Private;
+(function (Private) {
+    const _overrides = JSON.parse(PageConfig.getOption('settingsOverrides') || '{}');
+    /**
+     * Override the defaults of the schema with ones from PageConfig
+     *
+     * @see https://github.com/jupyterlab/jupyterlab_server/blob/v2.5.2/jupyterlab_server/settings_handler.py#L216-L227
+     */
+    function override(plugin) {
+        if (_overrides[plugin.id]) {
+            if (!plugin.schema.properties) {
+                // probably malformed, or only provides keyboard shortcuts, etc.
+                plugin.schema.properties = {};
+            }
+            for (const [prop, propDefault] of Object.entries(_overrides[plugin.id] || {})) {
+                plugin.schema.properties[prop].default = propDefault;
+            }
+        }
+        return plugin;
+    }
+    Private.override = override;
+})(Private || (Private = {}));
+//# sourceMappingURL=settings.js.map

package/lib/settings/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/settings/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAG3D,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAItD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAS/B;;GAEG;AACH,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,QAAS,SAAQ,cAAc;IAC1C;;OAEG;IACH,YAAY,OAA0B;QACpC,KAAK,CAAC;YACJ,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;QA6JG,iBAAY,GAAW,oBAAoB,CAAC;QAC5C,oBAAe,GAAoB,IAAI,CAAC;QA7J9C,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,WAAW,IAAI,oBAAoB,CAAC;QAChE,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC,cAAc,IAAI,IAAI,CAAC;QAEtD,IAAI,CAAC,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACpC,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAc,OAAO;QACnB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,QAAuB,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,WAAW;QACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,sBAAsB,EAAE,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAc,qBAAqB;;QACjC,MAAM,MAAM,GAAG,CAAA,MAAA,IAAI,CAAC,eAAe,0CAAE,MAAM,EAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1E,OAAO;YACL,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,IAAI,CAAC,YAAY;YACvB,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SAC9B,CAAC;IACJ,CAAC;IAED;;OAEG;IACO,sBAAsB;QAC9B,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;YACtC,WAAW,EAAE,8BAA8B;YAC3C,SAAS,EAAE,UAAU;YACrB,GAAG,IAAI,CAAC,qBAAqB;SAC9B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,QAAgB;QAC1B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAoC,CAAC;QAC1D,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAiC,EAAE,EAAE;YAClE,OAAO,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,WAAW,QAAQ,YAAY,CAAC,CAAC;QACnD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CACR,KAAa;;QAEb,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,YAAY,GAA+B,EAAE,CAAC;QAClD,IAAI,CAAC;YACH,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1D,CAAC;QAAC,MAAM,CAAC;YACP,wDAAwD;QAC1D,CAAC;QAED,6DAA6D;QAC7D,iEAAiE;QACjE,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAEzC,8CAA8C;QAC9C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QACnC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAChC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;;YACvB,MAAM,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC;YACtB,MAAM,GAAG,GAAG,MAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,CAAY,mCAAI,MAAM,CAAC,GAAG,CAAC;YAClE,OAAO;gBACL,GAAG,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3B,GAAG;gBACH,QAAQ,EAAE,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;aAC3B,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEF,sBAAsB;QACtB,MAAM,GAAG,GAAG,MAAA,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAgC,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,mCAAI,EAAE,CAAC;QAEhF,IAAI,MAAM,GAA+B,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM;gBACJ,MAAA,QAAQ,CAAC,GAAG,CAAC,CAAC,MAAgC,EAAE,EAAE;oBAChD,MAAM,CAAC,IAAI,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;oBAC1C,OAAO,MAAM,CAAC;gBAChB,CAAC,CAAC,mCAAI,EAAE,CAAC;QACb,CAAC;QAED,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC;IACzB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,EAAU,EAAE,GAAW;QAChC,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,OAAO,CAAC,IAAkB;;QACtC,MAAM,WAAW,GAAG,MAAA,UAAU,CAAC,SAAS,CAAC,aAAa,CAAC,mCAAI,GAAG,CAAC;QAC/D,MAAM,GAAG,GAAG,CAAC,MAAM,CACjB,MAAM,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAC5C,CAAC,IAAI,EAAE,CAA+B,CAAC;QACxC,OAAO,GAAG,CAAC;IACb,CAAC;CAOF;AAiBD;;GAEG;AACH,IAAU,OAAO,CAqBhB;AArBD,WAAU,OAAO;IACf,MAAM,UAAU,GACd,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,IAAI,CAAC,CAAC;IAEhE;;;;OAIG;IACH,SAAgB,QAAQ,CAAC,MAAgC;QACvD,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1B,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC;gBAC9B,gEAAgE;gBAChE,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;YAChC,CAAC;YACD,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBAC9E,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,WAAW,CAAC;YACvD,CAAC;QACH,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAXe,gBAAQ,WAWvB,CAAA;AACH,CAAC,EArBS,OAAO,KAAP,OAAO,QAqBhB"}