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

package/lib/settings.d.ts

@@ -1,8 +1,34 @@
-import { IPlugin } from './tokens';
+import type localforage from 'localforage';
+import { IPlugin, ISettings } from './tokens';
 /**
  * A class to handle requests to /api/settings
  */
-export declare class Settings {
+export declare class Settings implements ISettings {
+    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
      *
@@ -30,5 +56,22 @@ export declare class Settings {
      * @param pluginId The id of a plugin
      */
     private _getFederated;
+    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;
+    }
 }

package/lib/settings.js

@@ -1,20 +1,67 @@
 import { PageConfig, URLExt } from '@jupyterlab/coreutils';
 import * as json5 from 'json5';
-import localforage from 'localforage';
+import { PromiseDelegate } from '@lumino/coreutils';
 /**
  * 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._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();
+    }
+    /**
+     * 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',
-            version: 1
+            ...this.defaultStorageOptions,
         });
     }
     /**
@@ -40,15 +87,16 @@ export class Settings {
     async getAll() {
         var _a;
         const settingsUrl = (_a = PageConfig.getOption('settingsUrl')) !== null && _a !== void 0 ? _a : '/';
+        const storage = await this.storage;
         const all = (await (await fetch(URLExt.join(settingsUrl, 'all.json'))).json());
         const settings = await Promise.all(all.map(async (plugin) => {
             var _a;
             const { id } = plugin;
-            const raw = (_a = (await this._storage.getItem(id))) !== null && _a !== void 0 ? _a : plugin.raw;
+            const raw = (_a = (await storage.getItem(id))) !== null && _a !== void 0 ? _a : plugin.raw;
             return {
                 ...Private.override(plugin),
                 raw,
-                settings: json5.parse(raw)
+                settings: json5.parse(raw),
             };
         }));
         return { settings };
@@ -61,7 +109,7 @@ export class Settings {
      *
      */
     async save(pluginId, raw) {
-        await this._storage.setItem(pluginId, raw);
+        await (await this.storage).setItem(pluginId, raw);
     }
     /**
      * Get the settings for a federated extension
@@ -79,14 +127,14 @@ export class Settings {
         const packageUrl = URLExt.join(labExtensionsUrl, packageName, 'package.json');
         const schema = await (await fetch(schemaUrl)).json();
         const packageJson = await (await fetch(packageUrl)).json();
-        const raw = (_a = (await this._storage.getItem(pluginId))) !== null && _a !== void 0 ? _a : '{}';
+        const raw = (_a = (await (await this.storage).getItem(pluginId))) !== null && _a !== void 0 ? _a : '{}';
         const settings = json5.parse(raw) || {};
         return Private.override({
             id: pluginId,
             raw,
             schema,
             settings,
-            version: packageJson.version || '3.0.8'
+            version: packageJson.version || '3.0.8',
         });
     }
 }

package/lib/tokens.d.ts

@@ -33,6 +33,10 @@ export interface IPlugin extends PartialJSONObject {
  * 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
      *
@@ -55,26 +59,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.10",
   "description": "JupyterLite - Settings",
   "homepage": "https://github.com/jupyterlite/jupyterlite",
   "bugs": {
@@ -42,21 +42,22 @@
     "watch": "tsc -b --watch"
   },
   "dependencies": {
-    "@jupyterlab/coreutils": "~5.1.12",
-    "@jupyterlab/settingregistry": "~3.1.12",
-    "@lumino/coreutils": "^1.8.0",
+    "@jupyterlab/coreutils": "~5.4.3",
+    "@jupyterlab/settingregistry": "~3.4.3",
+    "@jupyterlite/localforage": "^0.1.0-beta.10",
+    "@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.4.3",
     "@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"