@jupyterlite/settings 0.1.0-alpha.9 → 0.1.0-beta.2

package/lib/settings.d.ts

@@ -3,6 +3,11 @@ import { IPlugin } from './tokens';
  * A class to handle requests to /api/settings
  */
 export declare class Settings {
+    constructor(options?: Settings.IOptions);
+    /**
+     * Create a settings store.
+     */
+    protected defaultSettingsStorage(): LocalForage;
     /**
      * Get settings by plugin id
      *
@@ -30,5 +35,18 @@ export declare class Settings {
      * @param pluginId The id of a plugin
      */
     private _getFederated;
+    private _settingsStorageName;
     private _storage;
 }
+/**
+ * A namespaces for settings metadata.
+ */
+declare namespace Settings {
+    /**
+     * Initialization options for settings.
+     */
+    interface IOptions {
+        settingsStorageName?: string | null;
+    }
+}
+export {};

package/lib/settings.js

@@ -4,17 +4,26 @@ import localforage from 'localforage';
 /**
  * The name of the local storage.
  */
-const STORAGE_NAME = 'JupyterLite Storage';
+const DEFAULT_STORAGE_NAME = 'JupyterLite Storage';
 /**
  * A class to handle requests to /api/settings
  */
 export class Settings {
-    constructor() {
-        this._storage = localforage.createInstance({
-            name: STORAGE_NAME,
+    constructor(options) {
+        this._settingsStorageName = DEFAULT_STORAGE_NAME;
+        this._settingsStorageName =
+            (options || {}).settingsStorageName || DEFAULT_STORAGE_NAME;
+        this._storage = this.defaultSettingsStorage();
+    }
+    /**
+     * Create a settings store.
+     */
+    defaultSettingsStorage() {
+        return localforage.createInstance({
+            name: this._settingsStorageName,
             description: 'Offline Storage for Settings',
             storeName: 'settings',
-            version: 1
+            version: 1,
         });
     }
     /**
@@ -48,7 +57,7 @@ export class Settings {
             return {
                 ...Private.override(plugin),
                 raw,
-                settings: json5.parse(raw)
+                settings: json5.parse(raw),
             };
         }));
         return { settings };
@@ -86,7 +95,7 @@ export class Settings {
             raw,
             schema,
             settings,
-            version: packageJson.version || '3.0.8'
+            version: packageJson.version || '3.0.8',
         });
     }
 }

package/lib/tokens.d.ts

@@ -55,26 +55,3 @@ export interface ISettings {
      */
     save(pluginId: string, raw: string): Promise<void>;
 }
-/**
- * The interface for a federated extension, as it appears in `jupyter-config-data`
- *
- * TODO: sync with schema, Lab core, etc.
- */
-export interface IFederatedExtension {
-    /**
-     * The npm-compatible name of the package
-     */
-    name: string;
-    /**
-     * The relative path to the extension
-     */
-    extension: string;
-    /**
-     * The relative entrypoint to the WebPack remoteEntry
-     */
-    load: string;
-    /**
-     * Optional path to the style module
-     */
-    style?: string;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jupyterlite/settings",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.2",
   "description": "JupyterLite - Settings",
   "homepage": "https://github.com/jupyterlite/jupyterlite",
   "bugs": {
@@ -42,21 +42,21 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/coreutils": "~5.1.12",
-    "@jupyterlab/settingregistry": "~3.1.12",
-    "@lumino/coreutils": "^1.8.0",
+    "@jupyterlab/coreutils": "~5.3.0",
+    "@jupyterlab/settingregistry": "~3.3.0",
+    "@lumino/coreutils": "^1.12.0",
     "json5": "^2.2.0",
     "localforage": "^1.9.0"
   },
   "devDependencies": {
     "@babel/core": "^7.11.6",
     "@babel/preset-env": "^7.12.1",
-    "@jupyterlab/testutils": "~3.1.12",
+    "@jupyterlab/testutils": "~3.3.0",
     "@types/jest": "^26.0.10",
     "jest": "^26.4.2",
     "rimraf": "~3.0.0",
     "ts-jest": "^26.3.0",
-    "typescript": "~4.2.3"
+    "typescript": "~4.5.2"
   },
   "publishConfig": {
     "access": "public"