@pezkuwi/ui-settings 3.16.7 → 3.16.8

package/package.json

@@ -15,11 +15,231 @@
   },
   "sideEffects": [
     "./packageDetect.js",
-    "./packageDetect.cjs"
+    "./cjs/packageDetect.js"
   ],
   "type": "module",
-  "version": "3.16.7",
-  "main": "index.js",
+  "version": "3.16.8",
+  "main": "./cjs/index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./cjs/package.json": "./cjs/package.json",
+    "./cjs/*": "./cjs/*.js",
+    ".": {
+      "module": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      },
+      "require": {
+        "types": "./cjs/index.d.ts",
+        "default": "./cjs/index.js"
+      },
+      "default": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
+    },
+    "./bundle": {
+      "module": {
+        "types": "./bundle.d.ts",
+        "default": "./bundle.js"
+      },
+      "require": {
+        "types": "./cjs/bundle.d.ts",
+        "default": "./cjs/bundle.js"
+      },
+      "default": {
+        "types": "./bundle.d.ts",
+        "default": "./bundle.js"
+      }
+    },
+    "./defaults": {
+      "module": {
+        "types": "./defaults/index.d.ts",
+        "default": "./defaults/index.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/index.d.ts",
+        "default": "./cjs/defaults/index.js"
+      },
+      "default": {
+        "types": "./defaults/index.d.ts",
+        "default": "./defaults/index.js"
+      }
+    },
+    "./defaults/chains": {
+      "module": {
+        "types": "./defaults/chains.d.ts",
+        "default": "./defaults/chains.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/chains.d.ts",
+        "default": "./cjs/defaults/chains.js"
+      },
+      "default": {
+        "types": "./defaults/chains.d.ts",
+        "default": "./defaults/chains.js"
+      }
+    },
+    "./defaults/crypto": {
+      "module": {
+        "types": "./defaults/crypto.d.ts",
+        "default": "./defaults/crypto.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/crypto.d.ts",
+        "default": "./cjs/defaults/crypto.js"
+      },
+      "default": {
+        "types": "./defaults/crypto.d.ts",
+        "default": "./defaults/crypto.js"
+      }
+    },
+    "./defaults/endpoints": {
+      "module": {
+        "types": "./defaults/endpoints.d.ts",
+        "default": "./defaults/endpoints.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/endpoints.d.ts",
+        "default": "./cjs/defaults/endpoints.js"
+      },
+      "default": {
+        "types": "./defaults/endpoints.d.ts",
+        "default": "./defaults/endpoints.js"
+      }
+    },
+    "./defaults/ledger": {
+      "module": {
+        "types": "./defaults/ledger.d.ts",
+        "default": "./defaults/ledger.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/ledger.d.ts",
+        "default": "./cjs/defaults/ledger.js"
+      },
+      "default": {
+        "types": "./defaults/ledger.d.ts",
+        "default": "./defaults/ledger.js"
+      }
+    },
+    "./defaults/ss58": {
+      "module": {
+        "types": "./defaults/ss58.d.ts",
+        "default": "./defaults/ss58.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/ss58.d.ts",
+        "default": "./cjs/defaults/ss58.js"
+      },
+      "default": {
+        "types": "./defaults/ss58.d.ts",
+        "default": "./defaults/ss58.js"
+      }
+    },
+    "./defaults/type": {
+      "module": {
+        "types": "./defaults/type.d.ts",
+        "default": "./defaults/type.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/type.d.ts",
+        "default": "./cjs/defaults/type.js"
+      },
+      "default": {
+        "types": "./defaults/type.d.ts",
+        "default": "./defaults/type.js"
+      }
+    },
+    "./defaults/ui": {
+      "module": {
+        "types": "./defaults/ui.d.ts",
+        "default": "./defaults/ui.js"
+      },
+      "require": {
+        "types": "./cjs/defaults/ui.d.ts",
+        "default": "./cjs/defaults/ui.js"
+      },
+      "default": {
+        "types": "./defaults/ui.d.ts",
+        "default": "./defaults/ui.js"
+      }
+    },
+    "./package.json": {
+      "require": "./cjs/package.json",
+      "default": "./package.json"
+    },
+    "./packageDetect": {
+      "module": {
+        "types": "./packageDetect.d.ts",
+        "default": "./packageDetect.js"
+      },
+      "require": {
+        "types": "./cjs/packageDetect.d.ts",
+        "default": "./cjs/packageDetect.js"
+      },
+      "default": {
+        "types": "./packageDetect.d.ts",
+        "default": "./packageDetect.js"
+      }
+    },
+    "./packageInfo.js": {
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
+    },
+    "./packageInfo": {
+      "module": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      },
+      "require": {
+        "types": "./cjs/packageInfo.d.ts",
+        "default": "./cjs/packageInfo.js"
+      },
+      "default": {
+        "types": "./packageInfo.d.ts",
+        "default": "./packageInfo.js"
+      }
+    },
+    "./Settings": {
+      "module": {
+        "types": "./Settings.d.ts",
+        "default": "./Settings.js"
+      },
+      "require": {
+        "types": "./cjs/Settings.d.ts",
+        "default": "./cjs/Settings.js"
+      },
+      "default": {
+        "types": "./Settings.d.ts",
+        "default": "./Settings.js"
+      }
+    },
+    "./types": {
+      "module": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      },
+      "require": {
+        "types": "./cjs/types.d.ts",
+        "default": "./cjs/types.js"
+      },
+      "default": {
+        "types": "./types.d.ts",
+        "default": "./types.js"
+      }
+    }
+  },
   "dependencies": {
     "@pezkuwi/networks": "^14.0.5",
     "@pezkuwi/util": "^14.0.5",
@@ -27,9 +247,6 @@
     "store": "^2.0.12",
     "tslib": "^2.8.1"
   },
-  "devDependencies": {
-    "@types/store": "^2.0.5"
-  },
   "peerDependencies": {
     "@pezkuwi/networks": "*",
     "@pezkuwi/util": "*"

package/build/README.md

@@ -1,40 +0,0 @@
-# @pezkuwi/ui-settings
-
-Manages app settings including endpoints, themes and prefixes
-
-## Usage Examples
-
-User preferences are set as a settings object in the browser's local storage.
-
-```js
-import settings from '@pezkuwi/ui-settings';
-
-render () {
-  // get api endpoint for the selected chain
-  const WS_URL = settings.apiUrl();
-
-  // get the selected il8n language
-  const language = settings.il8nLang();
-
-  // get all available il8n languages
-  const languages = settings.availableLanguages();
-
-  // update settings
-  const updatedSettings = {
-    ...settings,
-    i18nLang: 'Arabic'
-  }
-  settings.set(updatedSettings);
-
-  // NOTE: API currently does not handle hot reconnecting properly,
-  so you need to manually reload the page after updating settings.
-  window.location.reload();
-}
-```
-
-## Used by
-
-Apps that currently use the settings package
-
-* [pezkuwichain/apps](https://www.github.com/pezkuwichain/apps)
-* [paritytech/substrate-light-ui](https://github.com/paritytech/substrate-light-ui)

package/build/Settings.js

@@ -1,172 +0,0 @@
-import { EventEmitter } from 'eventemitter3';
-import store from 'store';
-import { hasProcess, isUndefined } from '@pezkuwi/util';
-import { CAMERA, CAMERA_DEFAULT, CRYPTOS, CRYPTOS_ETH, CRYPTOS_LEDGER, ENDPOINT_DEFAULT, ENDPOINTS, ICON_DEFAULT, ICONS, LANGUAGE_DEFAULT, LEDGER_APP, LEDGER_APP_DEFAULT, LEDGER_CONN, LEDGER_CONN_DEFAULT, LOCKING, LOCKING_DEFAULT, METADATA_UP, METADATA_UP_DEFAULT, NOTIFICATION_DEFAULT, PREFIX_DEFAULT, PREFIXES, STORAGE, STORAGE_DEFAULT, UIMODE_DEFAULT, UIMODES, UITHEME_DEFAULT, UITHEMES } from './defaults/index.js';
-function withDefault(options, option, fallback) {
-    const _option = option || fallback;
-    return options.some(({ value }) => value === _option)
-        ? _option
-        : fallback;
-}
-export class Settings {
-    #emitter;
-    #apiType;
-    // will become deprecated for supporting substrate connect light clients. apiType structure should be used instead
-    #apiUrl;
-    #camera;
-    #i18nLang;
-    #icon;
-    #ledgerApp;
-    #ledgerConn;
-    #locking;
-    #metadataUp;
-    #prefix;
-    #storage;
-    #uiMode;
-    #uiTheme;
-    #notification;
-    constructor() {
-        const settings = store.get('settings') || {};
-        this.#emitter = new EventEmitter();
-        // will become deprecated for supporting substrate connect light clients. apiType structure should be used instead
-        this.#apiUrl = (typeof settings.apiUrl === 'string' && settings.apiUrl) || (hasProcess && process.env?.['WS_URL']) || ENDPOINT_DEFAULT.value;
-        this.#apiType = { param: this.#apiUrl, type: 'json-rpc' };
-        this.#camera = withDefault(CAMERA, settings.camera, CAMERA_DEFAULT);
-        this.#ledgerApp = withDefault(LEDGER_APP, settings.ledgerApp, LEDGER_APP_DEFAULT);
-        this.#ledgerConn = withDefault(LEDGER_CONN, settings.ledgerConn, LEDGER_CONN_DEFAULT);
-        this.#i18nLang = settings.i18nLang || LANGUAGE_DEFAULT;
-        this.#icon = settings.icon || ICON_DEFAULT;
-        this.#locking = settings.locking || LOCKING_DEFAULT;
-        this.#metadataUp = withDefault(METADATA_UP, settings.storage, METADATA_UP_DEFAULT);
-        this.#notification = settings.notification || NOTIFICATION_DEFAULT;
-        this.#prefix = isUndefined(settings.prefix) ? PREFIX_DEFAULT : settings.prefix;
-        this.#storage = withDefault(STORAGE, settings.storage, STORAGE_DEFAULT);
-        this.#uiMode = settings.uiMode || UIMODE_DEFAULT;
-        this.#uiTheme = settings.uiTheme || UITHEME_DEFAULT;
-    }
-    get camera() {
-        return this.#camera;
-    }
-    get apiType() {
-        return this.#apiType;
-    }
-    get apiUrl() {
-        return this.#apiUrl;
-    }
-    get i18nLang() {
-        return this.#i18nLang;
-    }
-    get icon() {
-        return this.#icon;
-    }
-    get notification() {
-        return this.#notification;
-    }
-    get ledgerApp() {
-        return this.#ledgerApp;
-    }
-    get ledgerConn() {
-        return this.#ledgerConn;
-    }
-    get locking() {
-        return this.#locking;
-    }
-    get metadataUp() {
-        return this.#metadataUp;
-    }
-    get prefix() {
-        return this.#prefix;
-    }
-    get storage() {
-        return this.#storage;
-    }
-    get uiMode() {
-        return this.#uiMode;
-    }
-    get uiTheme() {
-        return this.#uiTheme;
-    }
-    get availableCamera() {
-        return CAMERA;
-    }
-    get availableCryptos() {
-        return CRYPTOS;
-    }
-    get availableCryptosEth() {
-        return CRYPTOS_ETH;
-    }
-    get availableCryptosLedger() {
-        return CRYPTOS_LEDGER;
-    }
-    get availableIcons() {
-        return ICONS;
-    }
-    get availableLedgerApp() {
-        return LEDGER_APP;
-    }
-    get availableLedgerConn() {
-        return LEDGER_CONN;
-    }
-    get availableLocking() {
-        return LOCKING;
-    }
-    get availableMetadataUp() {
-        return METADATA_UP;
-    }
-    get availableNodes() {
-        return ENDPOINTS;
-    }
-    get availablePrefixes() {
-        return PREFIXES;
-    }
-    get availableStorage() {
-        return STORAGE;
-    }
-    get availableUIModes() {
-        return UIMODES;
-    }
-    get availableUIThemes() {
-        return UITHEMES;
-    }
-    get() {
-        return {
-            apiType: this.#apiType,
-            apiUrl: this.#apiUrl,
-            camera: this.#camera,
-            i18nLang: this.#i18nLang,
-            icon: this.#icon,
-            ledgerApp: this.#ledgerApp,
-            ledgerConn: this.#ledgerConn,
-            locking: this.#locking,
-            metadataUp: this.#metadataUp,
-            notification: this.#notification,
-            prefix: this.#prefix,
-            storage: this.#storage,
-            uiMode: this.#uiMode,
-            uiTheme: this.#uiTheme
-        };
-    }
-    set(settings) {
-        this.#apiType = settings.apiType || this.#apiType;
-        this.#apiUrl = settings.apiUrl || this.#apiUrl;
-        this.#camera = settings.camera || this.#camera;
-        this.#ledgerConn = settings.ledgerConn || this.#ledgerConn;
-        this.#ledgerApp = settings.ledgerApp || this.#ledgerApp;
-        this.#i18nLang = settings.i18nLang || this.#i18nLang;
-        this.#icon = settings.icon || this.#icon;
-        this.#locking = settings.locking || this.#locking;
-        this.#metadataUp = settings.metadataUp || this.#metadataUp;
-        this.#notification = settings.notification || this.#notification;
-        this.#prefix = isUndefined(settings.prefix) ? this.#prefix : settings.prefix;
-        this.#storage = settings.storage || this.#storage;
-        this.#uiMode = settings.uiMode || this.#uiMode;
-        this.#uiTheme = settings.uiTheme || this.#uiTheme;
-        const newValues = this.get();
-        store.set('settings', newValues);
-        this.#emitter.emit('change', newValues);
-    }
-    on(type, cb) {
-        this.#emitter.on(type, cb);
-    }
-}
-export const settings = new Settings();

package/build/bundle.js

@@ -1,5 +0,0 @@
-import { Settings, settings } from './Settings.js';
-export { chains } from './defaults/chains.js';
-export { ENDPOINT_DEFAULT, ICON_DEFAULT, ICON_DEFAULT_HOST, LANGUAGE_DEFAULT, LOCKING_DEFAULT, PREFIX_DEFAULT, UIMODE_DEFAULT, UITHEME_DEFAULT } from './defaults/index.js';
-export { packageInfo } from './packageInfo.js';
-export { Settings, settings };

package/build/cjs/Settings.d.ts

@@ -1,40 +0,0 @@
-import type { Endpoint, Option, SettingsStruct } from './types.js';
-type ChangeCallback = (settings: SettingsStruct) => void;
-type OnTypes = 'change';
-export declare class Settings implements SettingsStruct {
-    #private;
-    constructor();
-    get camera(): string;
-    get apiType(): Endpoint;
-    get apiUrl(): string;
-    get i18nLang(): string;
-    get icon(): string;
-    get notification(): string;
-    get ledgerApp(): string;
-    get ledgerConn(): string;
-    get locking(): string;
-    get metadataUp(): string;
-    get prefix(): number;
-    get storage(): string;
-    get uiMode(): string;
-    get uiTheme(): string;
-    get availableCamera(): Option[];
-    get availableCryptos(): Option[];
-    get availableCryptosEth(): Option[];
-    get availableCryptosLedger(): Option[];
-    get availableIcons(): Option[];
-    get availableLedgerApp(): Option[];
-    get availableLedgerConn(): Option[];
-    get availableLocking(): Option[];
-    get availableMetadataUp(): Option[];
-    get availableNodes(): Option[];
-    get availablePrefixes(): Option[];
-    get availableStorage(): Option[];
-    get availableUIModes(): Option[];
-    get availableUIThemes(): Option[];
-    get(): SettingsStruct;
-    set(settings: Partial<SettingsStruct>): void;
-    on(type: OnTypes, cb: ChangeCallback): void;
-}
-export declare const settings: Settings;
-export {};

package/build/cjs/Settings.js

@@ -1,177 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.settings = exports.Settings = void 0;
-const tslib_1 = require("tslib");
-const eventemitter3_1 = require("eventemitter3");
-const store_1 = tslib_1.__importDefault(require("store"));
-const util_1 = require("@pezkuwi/util");
-const index_js_1 = require("./defaults/index.js");
-function withDefault(options, option, fallback) {
-    const _option = option || fallback;
-    return options.some(({ value }) => value === _option)
-        ? _option
-        : fallback;
-}
-class Settings {
-    #emitter;
-    #apiType;
-    // will become deprecated for supporting substrate connect light clients. apiType structure should be used instead
-    #apiUrl;
-    #camera;
-    #i18nLang;
-    #icon;
-    #ledgerApp;
-    #ledgerConn;
-    #locking;
-    #metadataUp;
-    #prefix;
-    #storage;
-    #uiMode;
-    #uiTheme;
-    #notification;
-    constructor() {
-        const settings = store_1.default.get('settings') || {};
-        this.#emitter = new eventemitter3_1.EventEmitter();
-        // will become deprecated for supporting substrate connect light clients. apiType structure should be used instead
-        this.#apiUrl = (typeof settings.apiUrl === 'string' && settings.apiUrl) || (util_1.hasProcess && process.env?.['WS_URL']) || index_js_1.ENDPOINT_DEFAULT.value;
-        this.#apiType = { param: this.#apiUrl, type: 'json-rpc' };
-        this.#camera = withDefault(index_js_1.CAMERA, settings.camera, index_js_1.CAMERA_DEFAULT);
-        this.#ledgerApp = withDefault(index_js_1.LEDGER_APP, settings.ledgerApp, index_js_1.LEDGER_APP_DEFAULT);
-        this.#ledgerConn = withDefault(index_js_1.LEDGER_CONN, settings.ledgerConn, index_js_1.LEDGER_CONN_DEFAULT);
-        this.#i18nLang = settings.i18nLang || index_js_1.LANGUAGE_DEFAULT;
-        this.#icon = settings.icon || index_js_1.ICON_DEFAULT;
-        this.#locking = settings.locking || index_js_1.LOCKING_DEFAULT;
-        this.#metadataUp = withDefault(index_js_1.METADATA_UP, settings.storage, index_js_1.METADATA_UP_DEFAULT);
-        this.#notification = settings.notification || index_js_1.NOTIFICATION_DEFAULT;
-        this.#prefix = (0, util_1.isUndefined)(settings.prefix) ? index_js_1.PREFIX_DEFAULT : settings.prefix;
-        this.#storage = withDefault(index_js_1.STORAGE, settings.storage, index_js_1.STORAGE_DEFAULT);
-        this.#uiMode = settings.uiMode || index_js_1.UIMODE_DEFAULT;
-        this.#uiTheme = settings.uiTheme || index_js_1.UITHEME_DEFAULT;
-    }
-    get camera() {
-        return this.#camera;
-    }
-    get apiType() {
-        return this.#apiType;
-    }
-    get apiUrl() {
-        return this.#apiUrl;
-    }
-    get i18nLang() {
-        return this.#i18nLang;
-    }
-    get icon() {
-        return this.#icon;
-    }
-    get notification() {
-        return this.#notification;
-    }
-    get ledgerApp() {
-        return this.#ledgerApp;
-    }
-    get ledgerConn() {
-        return this.#ledgerConn;
-    }
-    get locking() {
-        return this.#locking;
-    }
-    get metadataUp() {
-        return this.#metadataUp;
-    }
-    get prefix() {
-        return this.#prefix;
-    }
-    get storage() {
-        return this.#storage;
-    }
-    get uiMode() {
-        return this.#uiMode;
-    }
-    get uiTheme() {
-        return this.#uiTheme;
-    }
-    get availableCamera() {
-        return index_js_1.CAMERA;
-    }
-    get availableCryptos() {
-        return index_js_1.CRYPTOS;
-    }
-    get availableCryptosEth() {
-        return index_js_1.CRYPTOS_ETH;
-    }
-    get availableCryptosLedger() {
-        return index_js_1.CRYPTOS_LEDGER;
-    }
-    get availableIcons() {
-        return index_js_1.ICONS;
-    }
-    get availableLedgerApp() {
-        return index_js_1.LEDGER_APP;
-    }
-    get availableLedgerConn() {
-        return index_js_1.LEDGER_CONN;
-    }
-    get availableLocking() {
-        return index_js_1.LOCKING;
-    }
-    get availableMetadataUp() {
-        return index_js_1.METADATA_UP;
-    }
-    get availableNodes() {
-        return index_js_1.ENDPOINTS;
-    }
-    get availablePrefixes() {
-        return index_js_1.PREFIXES;
-    }
-    get availableStorage() {
-        return index_js_1.STORAGE;
-    }
-    get availableUIModes() {
-        return index_js_1.UIMODES;
-    }
-    get availableUIThemes() {
-        return index_js_1.UITHEMES;
-    }
-    get() {
-        return {
-            apiType: this.#apiType,
-            apiUrl: this.#apiUrl,
-            camera: this.#camera,
-            i18nLang: this.#i18nLang,
-            icon: this.#icon,
-            ledgerApp: this.#ledgerApp,
-            ledgerConn: this.#ledgerConn,
-            locking: this.#locking,
-            metadataUp: this.#metadataUp,
-            notification: this.#notification,
-            prefix: this.#prefix,
-            storage: this.#storage,
-            uiMode: this.#uiMode,
-            uiTheme: this.#uiTheme
-        };
-    }
-    set(settings) {
-        this.#apiType = settings.apiType || this.#apiType;
-        this.#apiUrl = settings.apiUrl || this.#apiUrl;
-        this.#camera = settings.camera || this.#camera;
-        this.#ledgerConn = settings.ledgerConn || this.#ledgerConn;
-        this.#ledgerApp = settings.ledgerApp || this.#ledgerApp;
-        this.#i18nLang = settings.i18nLang || this.#i18nLang;
-        this.#icon = settings.icon || this.#icon;
-        this.#locking = settings.locking || this.#locking;
-        this.#metadataUp = settings.metadataUp || this.#metadataUp;
-        this.#notification = settings.notification || this.#notification;
-        this.#prefix = (0, util_1.isUndefined)(settings.prefix) ? this.#prefix : settings.prefix;
-        this.#storage = settings.storage || this.#storage;
-        this.#uiMode = settings.uiMode || this.#uiMode;
-        this.#uiTheme = settings.uiTheme || this.#uiTheme;
-        const newValues = this.get();
-        store_1.default.set('settings', newValues);
-        this.#emitter.emit('change', newValues);
-    }
-    on(type, cb) {
-        this.#emitter.on(type, cb);
-    }
-}
-exports.Settings = Settings;
-exports.settings = new Settings();

package/build/cjs/bundle.d.ts

@@ -1,5 +0,0 @@
-import { Settings, settings } from './Settings.js';
-export { chains } from './defaults/chains.js';
-export { ENDPOINT_DEFAULT, ICON_DEFAULT, ICON_DEFAULT_HOST, LANGUAGE_DEFAULT, LOCKING_DEFAULT, PREFIX_DEFAULT, UIMODE_DEFAULT, UITHEME_DEFAULT } from './defaults/index.js';
-export { packageInfo } from './packageInfo.js';
-export { Settings, settings };