@jupyterlite/settings 0.6.0-alpha.1 → 0.6.0-alpha.3

package/lib/index.d.ts

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

package/lib/index.js

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

package/lib/index.js.map

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

package/lib/settings.d.ts

@@ -1,9 +1,17 @@
+import { ServerConnection, Setting, SettingManager } from '@jupyterlab/services';
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
 import type localforage from 'localforage';
-import { IPlugin, ISettings } from './tokens';
 /**
- * A class to handle requests to /api/settings
+ * The settings file to request
  */
-export declare class Settings implements ISettings {
+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
@@ -35,12 +43,13 @@ export declare class Settings implements ISettings {
      * @param pluginId the id of the plugin
      *
      */
-    get(pluginId: string): Promise<IPlugin | undefined>;
+    fetch(pluginId: string): Promise<ISettingRegistry.IPlugin>;
     /**
      * Get all the settings
      */
-    getAll(): Promise<{
-        settings: IPlugin[];
+    list(query?: 'ids'): Promise<{
+        ids: string[];
+        values: ISettingRegistry.IPlugin[];
     }>;
     /**
      * Save settings for a given plugin id
@@ -49,7 +58,7 @@ export declare class Settings implements ISettings {
      * @param raw The raw settings
      *
      */
-    save(pluginId: string, raw: string): Promise<void>;
+    save(id: string, raw: string): Promise<void>;
     /**
      * Get all the settings for core or federated plugins
      */
@@ -71,5 +80,6 @@ export declare namespace Settings {
         localforage: typeof localforage;
         storageName?: string | null;
         storageDrivers?: string[] | null;
+        serverSettings?: ServerConnection.ISettings;
     }
 }

package/lib/settings.js

@@ -1,4 +1,5 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
+import { SettingManager } from '@jupyterlab/services';
 import { PromiseDelegate } from '@lumino/coreutils';
 import * as json5 from 'json5';
 /**
@@ -6,16 +7,23 @@ import * as json5 from 'json5';
  */
 const DEFAULT_STORAGE_NAME = 'JupyterLite Storage';
 /**
- * A class to handle requests to /api/settings
+ * A class to manage settings in the browser.
  */
-export class Settings {
+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
@@ -70,18 +78,22 @@ export class Settings {
      * @param pluginId the id of the plugin
      *
      */
-    async get(pluginId) {
-        const all = await this.getAll();
-        const settings = all.settings;
+    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 getAll() {
+    async list(query) {
+        var _a, _b;
         const allCore = await this._getAll('all.json');
         let allFederated = [];
         try {
@@ -105,7 +117,17 @@ export class Settings {
                 settings: json5.parse(raw),
             };
         }));
-        return { settings };
+        // 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
@@ -114,8 +136,8 @@ export class Settings {
      * @param raw The raw settings
      *
      */
-    async save(pluginId, raw) {
-        await (await this.storage).setItem(pluginId, raw);
+    async save(id, raw) {
+        await (await this.storage).setItem(id, raw);
     }
     /**
      * Get all the settings for core or federated plugins

package/lib/settings.js.map

@@ -1 +1 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAM/B;;GAEG;AACH,MAAM,oBAAoB,GAAG,qBAAqB,CAAC;AAEnD;;GAEG;AACH,MAAM,OAAO,QAAQ;IACnB,YAAY,OAA0B;QAiI9B,iBAAY,GAAW,oBAAoB,CAAC;QAC5C,oBAAe,GAAoB,IAAI,CAAC;QAjI9C,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;IACtC,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,GAAG,CAAC,QAAgB;QACxB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAqB,CAAC;QAC3C,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAgB,EAAE,EAAE;YACjD,OAAO,OAAO,CAAC,EAAE,KAAK,QAAQ,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,YAAY,GAAc,EAAE,CAAC;QACjC,IAAI;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;SACzD;QAAC,MAAM;YACN,wDAAwD;SACzD;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;QACF,OAAO,EAAE,QAAQ,EAAE,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CAAC,QAAgB,EAAE,GAAW;QACtC,MAAM,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;IACpD,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,CAAc,CAAC;QACvB,OAAO,GAAG,CAAC;IACb,CAAC;CAOF;AAgBD;;GAEG;AACH,IAAU,OAAO,CAsBhB;AAtBD,WAAU,OAAO;IACf,MAAM,UAAU,GAAiD,IAAI,CAAC,KAAK,CACzE,UAAU,CAAC,SAAS,CAAC,mBAAmB,CAAC,IAAI,IAAI,CAClD,CAAC;IAEF;;;;OAIG;IACH,SAAgB,QAAQ,CAAC,MAAe;QACtC,IAAI,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE;YACzB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC7B,gEAAgE;gBAChE,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;aAC/B;YACD,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC7E,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,WAAW,CAAC;aACtD;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAXe,gBAAQ,WAWvB,CAAA;AACH,CAAC,EAtBS,OAAO,KAAP,OAAO,QAsBhB"}
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../src/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAA6B,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAIjF,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;QAoJG,iBAAY,GAAW,oBAAoB,CAAC;QAC5C,oBAAe,GAAoB,IAAI,CAAC;QApJ9C,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;YACZ,MAAM,IAAI,KAAK,CAAC,WAAW,QAAQ,YAAY,CAAC,CAAC;SAClD;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;YACF,YAAY,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;SACzD;QAAC,MAAM;YACN,wDAAwD;SACzD;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;YACV,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;SACZ;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;;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;YACzB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;gBAC7B,gEAAgE;gBAChE,MAAM,CAAC,MAAM,CAAC,UAAU,GAAG,EAAE,CAAC;aAC/B;YACD,KAAK,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE;gBAC7E,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,WAAW,CAAC;aACtD;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAXe,gBAAQ,WAWvB,CAAA;AACH,CAAC,EArBS,OAAO,KAAP,OAAO,QAqBhB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlite/settings",
-  "version": "0.6.0-alpha.1",
+  "version": "0.6.0-alpha.3",
   "description": "JupyterLite - Settings",
   "homepage": "https://github.com/jupyterlite/jupyterlite",
   "bugs": {
@@ -43,9 +43,9 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/coreutils": "~6.4.0-alpha.3",
-    "@jupyterlab/settingregistry": "~4.4.0-alpha.3",
-    "@jupyterlite/localforage": "^0.6.0-alpha.1",
+    "@jupyterlab/coreutils": "~6.4.0-beta.1",
+    "@jupyterlab/settingregistry": "~4.4.0-beta.1",
+    "@jupyterlite/localforage": "^0.6.0-alpha.3",
     "@lumino/coreutils": "^2.2.0",
     "json5": "^2.2.0",
     "localforage": "^1.9.0"
@@ -53,12 +53,12 @@
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.12.1",
-    "@jupyterlab/testutils": "~4.4.0-alpha.3",
+    "@jupyterlab/testutils": "~4.4.0-beta.1",
     "@types/jest": "^29.5.3",
     "jest": "^29.6.2",
     "rimraf": "~5.0.1",
     "ts-jest": "^29.1.1",
-    "typescript": "~5.1.6"
+    "typescript": "~5.5.4"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -2,4 +2,3 @@
 // Distributed under the terms of the Modified BSD License.
 
 export * from './settings';
-export * from './tokens';

package/src/settings.ts

@@ -1,12 +1,19 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 
+import { ServerConnection, Setting, SettingManager } from '@jupyterlab/services';
+
+import { ISettingRegistry } from '@jupyterlab/settingregistry';
+
 import { PromiseDelegate } from '@lumino/coreutils';
 
 import * as json5 from 'json5';
 
 import type localforage from 'localforage';
 
-import { IPlugin, ISettings, SettingsFile } from './tokens';
+/**
+ * The settings file to request
+ */
+export type SettingsFile = 'all.json' | 'all_federated.json';
 
 /**
  * The name of the local storage.
@@ -14,15 +21,22 @@ import { IPlugin, ISettings, SettingsFile } from './tokens';
 const DEFAULT_STORAGE_NAME = 'JupyterLite Storage';
 
 /**
- * A class to handle requests to /api/settings
+ * A class to manage settings in the browser.
  */
-export class Settings implements ISettings {
+export class Settings extends SettingManager implements Setting.IManager {
+  /**
+   * Create a new settings service.
+   */
   constructor(options: Settings.IOptions) {
+    super({
+      serverSettings: options.serverSettings,
+    });
     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);
   }
 
   /**
@@ -83,21 +97,26 @@ export class Settings implements ISettings {
    * @param pluginId the id of the plugin
    *
    */
-  async get(pluginId: string): Promise<IPlugin | undefined> {
-    const all = await this.getAll();
-    const settings = all.settings as IPlugin[];
-    const setting = settings.find((setting: IPlugin) => {
+  async fetch(pluginId: string): Promise<ISettingRegistry.IPlugin> {
+    const all = await this.list();
+    const settings = all.values as ISettingRegistry.IPlugin[];
+    const setting = settings.find((setting: ISettingRegistry.IPlugin) => {
       return setting.id === pluginId;
     });
+    if (!setting) {
+      throw new Error(`Setting ${pluginId} not found`);
+    }
     return setting;
   }
 
   /**
    * Get all the settings
    */
-  async getAll(): Promise<{ settings: IPlugin[] }> {
+  async list(
+    query?: 'ids',
+  ): Promise<{ ids: string[]; values: ISettingRegistry.IPlugin[] }> {
     const allCore = await this._getAll('all.json');
-    let allFederated: IPlugin[] = [];
+    let allFederated: ISettingRegistry.IPlugin[] = [];
     try {
       allFederated = await this._getAll('all_federated.json');
     } catch {
@@ -121,7 +140,20 @@ export class Settings implements ISettings {
         };
       }),
     );
-    return { settings };
+
+    // format the settings
+    const ids = settings.map((plugin: ISettingRegistry.IPlugin) => plugin.id) ?? [];
+
+    let values: ISettingRegistry.IPlugin[] = [];
+    if (!query) {
+      values =
+        settings.map((plugin: ISettingRegistry.IPlugin) => {
+          plugin.data = { composite: {}, user: {} };
+          return plugin;
+        }) ?? [];
+    }
+
+    return { ids, values };
   }
 
   /**
@@ -131,18 +163,18 @@ export class Settings implements ISettings {
    * @param raw The raw settings
    *
    */
-  async save(pluginId: string, raw: string): Promise<void> {
-    await (await this.storage).setItem(pluginId, raw);
+  async save(id: string, raw: string): Promise<void> {
+    await (await this.storage).setItem(id, raw);
   }
 
   /**
    * Get all the settings for core or federated plugins
    */
-  private async _getAll(file: SettingsFile): Promise<IPlugin[]> {
+  private async _getAll(file: SettingsFile): Promise<ISettingRegistry.IPlugin[]> {
     const settingsUrl = PageConfig.getOption('settingsUrl') ?? '/';
     const all = (await (
       await fetch(URLExt.join(settingsUrl, file))
-    ).json()) as IPlugin[];
+    ).json()) as ISettingRegistry.IPlugin[];
     return all;
   }
 
@@ -164,6 +196,7 @@ export namespace Settings {
     localforage: typeof localforage;
     storageName?: string | null;
     storageDrivers?: string[] | null;
+    serverSettings?: ServerConnection.ISettings;
   }
 }
 
@@ -171,16 +204,15 @@ export namespace Settings {
  * A namespace for private data
  */
 namespace Private {
-  const _overrides: Record<string, IPlugin['schema']['default']> = JSON.parse(
-    PageConfig.getOption('settingsOverrides') || '{}',
-  );
+  const _overrides: Record<string, ISettingRegistry.IPlugin['schema']['default']> =
+    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
    */
-  export function override(plugin: IPlugin): IPlugin {
+  export function override(plugin: ISettingRegistry.IPlugin): ISettingRegistry.IPlugin {
     if (_overrides[plugin.id]) {
       if (!plugin.schema.properties) {
         // probably malformed, or only provides keyboard shortcuts, etc.

package/lib/tokens.d.ts

@@ -1,65 +0,0 @@
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
-import { JSONObject, PartialJSONObject, Token } from '@lumino/coreutils';
-/**
- * The token for the settings service.
- */
-export declare const ISettings: Token<ISettings>;
-/**
- * The settings file to request
- */
-export type SettingsFile = 'all.json' | 'all_federated.json';
-/**
- * An interface for the plugin settings.
- */
-export interface IPlugin extends PartialJSONObject {
-    /**
-     * The name of the plugin.
-     */
-    id: string;
-    /**
-     * The settings for the plugin.
-     */
-    settings: JSONObject;
-    /**
-     * The raw user settings data as a string containing JSON with comments.
-     */
-    raw: string;
-    /**
-     * The JSON schema for the plugin.
-     */
-    schema: ISettingRegistry.ISchema;
-    /**
-     * The published version of the NPM package containing the plugin.
-     */
-    version: string;
-}
-/**
- * The interface for the Settings service.
- */
-export interface ISettings {
-    /**
-     * A promise that resolves after the settings have been full initialized
-     */
-    ready: Promise<void>;
-    /**
-     * Get settings by plugin id
-     *
-     * @param pluginId the id of the plugin
-     *
-     */
-    get(pluginId: string): Promise<IPlugin | undefined>;
-    /**
-     * Get all the settings
-     */
-    getAll(): Promise<{
-        settings: IPlugin[];
-    }>;
-    /**
-     * Save settings for a given plugin id
-     *
-     * @param pluginId The id of the plugin
-     * @param raw The raw settings
-     *
-     */
-    save(pluginId: string, raw: string): Promise<void>;
-}

package/lib/tokens.js

@@ -1,6 +0,0 @@
-import { Token } from '@lumino/coreutils';
-/**
- * The token for the settings service.
- */
-export const ISettings = new Token('@jupyterlite/settings:ISettings');
-//# sourceMappingURL=tokens.js.map

package/lib/tokens.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tokens.js","sourceRoot":"","sources":["../src/tokens.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiC,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAEzE;;GAEG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,IAAI,KAAK,CAAY,iCAAiC,CAAC,CAAC"}

package/src/tokens.ts

@@ -1,75 +0,0 @@
-import { ISettingRegistry } from '@jupyterlab/settingregistry';
-
-import { JSONObject, PartialJSONObject, Token } from '@lumino/coreutils';
-
-/**
- * The token for the settings service.
- */
-export const ISettings = new Token<ISettings>('@jupyterlite/settings:ISettings');
-
-/**
- * The settings file to request
- */
-export type SettingsFile = 'all.json' | 'all_federated.json';
-
-/**
- * An interface for the plugin settings.
- */
-export interface IPlugin extends PartialJSONObject {
-  /**
-   * The name of the plugin.
-   */
-  id: string;
-
-  /**
-   * The settings for the plugin.
-   */
-  settings: JSONObject;
-
-  /**
-   * The raw user settings data as a string containing JSON with comments.
-   */
-  raw: string;
-
-  /**
-   * The JSON schema for the plugin.
-   */
-  schema: ISettingRegistry.ISchema;
-
-  /**
-   * The published version of the NPM package containing the plugin.
-   */
-  version: string;
-}
-
-/**
- * The interface for the Settings service.
- */
-export interface ISettings {
-  /**
-   * A promise that resolves after the settings have been full initialized
-   */
-  ready: Promise<void>;
-
-  /**
-   * Get settings by plugin id
-   *
-   * @param pluginId the id of the plugin
-   *
-   */
-  get(pluginId: string): Promise<IPlugin | undefined>;
-
-  /**
-   * Get all the settings
-   */
-  getAll(): Promise<{ settings: IPlugin[] }>;
-
-  /**
-   * Save settings for a given plugin id
-   *
-   * @param pluginId The id of the plugin
-   * @param raw The raw settings
-   *
-   */
-  save(pluginId: string, raw: string): Promise<void>;
-}