@pezkuwi/ui-settings 3.16.6

package/build-tsc-esm/Settings.js

@@ -0,0 +1,172 @@
+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-tsc-esm/bundle.js

@@ -0,0 +1,5 @@
+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-tsc-esm/defaults/chains.js

@@ -0,0 +1,5 @@
+import { selectableNetworks } from '@pezkuwi/networks';
+import { objectSpread } from '@pezkuwi/util';
+export const chains = /*#__PURE__*/ selectableNetworks
+    .filter((n) => n.genesisHash.length)
+    .reduce((chains, { genesisHash, network }) => objectSpread(chains, { [network]: genesisHash }), {});

package/build-tsc-esm/defaults/crypto.js

@@ -0,0 +1,32 @@
+export const CRYPTOS = [
+    {
+        info: 'sr25519',
+        text: 'Schnorrkel (sr25519, recommended)',
+        value: 'sr25519'
+    },
+    {
+        info: 'ed25519',
+        text: 'Edwards (ed25519, alternative)',
+        value: 'ed25519'
+    },
+    {
+        info: 'ecdsa',
+        text: 'ECDSA (Non BTC/ETH compatible)',
+        value: 'ecdsa'
+    }
+];
+export const CRYPTOS_ETH = [
+    {
+        info: 'ethereum',
+        text: 'ECDSA (ETH compatible)',
+        value: 'ethereum'
+    }
+];
+export const CRYPTOS_LEDGER = [
+    ...CRYPTOS,
+    {
+        info: 'ed25519-ledger',
+        text: 'Ledger (ed25519, BIP32 derivation)',
+        value: 'ed25519-ledger'
+    }
+];

package/build-tsc-esm/defaults/endpoints.js

@@ -0,0 +1,8 @@
+export const ENDPOINTS = [
+    {
+        info: 'local',
+        text: 'Local Node (Own, 127.0.0.1:9944)',
+        value: 'ws://127.0.0.1:9944/'
+    }
+];
+export const ENDPOINT_DEFAULT = ENDPOINTS[0];

package/build-tsc-esm/defaults/index.js

@@ -0,0 +1,58 @@
+export { CRYPTOS, CRYPTOS_ETH, CRYPTOS_LEDGER } from './crypto.js';
+export { ENDPOINT_DEFAULT, ENDPOINTS } from './endpoints.js';
+export { LEDGER_APP, LEDGER_APP_DEFAULT, LEDGER_CONN, LEDGER_CONN_DEFAULT } from './ledger.js';
+export { PREFIX_DEFAULT, PREFIXES } from './ss58.js';
+export { ICON_DEFAULT, ICON_DEFAULT_HOST, ICONS, NOTIFICATION_DEFAULT, UIMODE_DEFAULT, UIMODES, UITHEME_DEFAULT, UITHEMES } from './ui.js';
+export const CAMERA_DEFAULT = 'off';
+export const CAMERA = [
+    {
+        info: 'on',
+        text: 'Allow camera access',
+        value: 'on'
+    },
+    {
+        info: 'off',
+        text: 'Do not allow camera access',
+        value: 'off'
+    }
+];
+export const LANGUAGE_DEFAULT = 'default';
+export const LOCKING_DEFAULT = 'session';
+export const LOCKING = [
+    {
+        info: 'session',
+        text: 'Once per session',
+        value: 'session'
+    },
+    {
+        info: 'tx',
+        text: 'On each transaction',
+        value: 'tx'
+    }
+];
+export const METADATA_UP_DEFAULT = 'off';
+export const METADATA_UP = [
+    {
+        info: 'off',
+        text: 'Do not auto-update extension metadata',
+        value: 'off'
+    },
+    {
+        info: 'on',
+        text: 'Auto-update extension metadata',
+        value: 'on'
+    }
+];
+export const STORAGE_DEFAULT = 'off';
+export const STORAGE = [
+    {
+        info: 'on',
+        text: 'Allow local in-browser account storage',
+        value: 'on'
+    },
+    {
+        info: 'off',
+        text: 'Do not allow local in-browser account storage',
+        value: 'off'
+    }
+];

package/build-tsc-esm/defaults/ledger.js

@@ -0,0 +1,42 @@
+export const LEDGER_CONN_DEFAULT = 'none';
+export const LEDGER_CONN = [
+    {
+        info: 'none',
+        text: 'Do not attach Ledger devices',
+        value: 'none'
+    },
+    // Deprecated
+    // {
+    //   info: 'u2f',
+    //   text: 'Attach Ledger via U2F',
+    //   value: 'u2f'
+    // },
+    {
+        info: 'webusb',
+        text: 'Attach Ledger via WebUSB (Chrome, recommended)',
+        value: 'webusb'
+    },
+    {
+        info: 'hid',
+        text: 'Attach Ledger via WebHID (Chrome, experimental)',
+        value: 'hid'
+    }
+];
+export const LEDGER_APP_DEFAULT = 'generic';
+export const LEDGER_APP = [
+    {
+        info: 'generic',
+        text: 'Use the Ledger Polkadot Generic App',
+        value: 'generic'
+    },
+    {
+        info: 'migration',
+        text: 'Use the Ledger Migration App',
+        value: 'migration'
+    },
+    {
+        info: 'chainSpecific',
+        text: 'Use the Chain Specific Ledger App',
+        value: 'chainSpecific'
+    }
+];

package/build-tsc-esm/defaults/ss58.js

@@ -0,0 +1,13 @@
+import { availableNetworks } from '@pezkuwi/networks';
+export const PREFIX_DEFAULT = -1;
+const defaultNetwork = {
+    info: 'default',
+    text: 'Default for the connected node',
+    value: -1
+};
+const networks = availableNetworks.map(({ displayName, network, prefix }) => ({
+    info: network,
+    text: displayName,
+    value: prefix
+}));
+export const PREFIXES = [defaultNetwork, ...networks];

package/build-tsc-esm/defaults/type.js

@@ -0,0 +1 @@
+export const isPolkadot = typeof window !== 'undefined' && window.location.host.includes('polkadot');

package/build-tsc-esm/defaults/ui.js

@@ -0,0 +1,59 @@
+import { isPolkadot } from './type.js';
+export const LANGUAGE_DEFAULT = 'default';
+export const UIMODE_DEFAULT = !isPolkadot && typeof window !== 'undefined' && window.location.host.includes('ui-light')
+    ? 'light'
+    : 'full';
+export const UIMODES = [
+    {
+        info: 'full',
+        text: 'Fully featured',
+        value: 'full'
+    },
+    {
+        info: 'light',
+        text: 'Basic features only',
+        value: 'light'
+    }
+];
+export const UITHEME_DEFAULT = isPolkadot
+    ? 'polkadot'
+    : 'substrate';
+export const UITHEMES = [
+    {
+        info: 'polkadot',
+        text: 'Polkadot',
+        value: 'polkadot'
+    },
+    {
+        info: 'substrate',
+        text: 'Substrate',
+        value: 'substrate'
+    }
+];
+export const ICON_DEFAULT = 'default';
+export const ICON_DEFAULT_HOST = isPolkadot
+    ? 'polkadot'
+    : 'substrate';
+export const ICONS = [
+    {
+        info: 'default',
+        text: 'Default for the connected node',
+        value: 'default'
+    },
+    {
+        info: 'polkadot',
+        text: 'Polkadot',
+        value: 'polkadot'
+    },
+    {
+        info: 'substrate',
+        text: 'Substrate',
+        value: 'substrate'
+    },
+    {
+        info: 'beachball',
+        text: 'Beachball',
+        value: 'beachball'
+    }
+];
+export const NOTIFICATION_DEFAULT = 'popup';

package/build-tsc-esm/index.js

@@ -0,0 +1,3 @@
+import { settings } from './bundle.js';
+export * from './bundle.js';
+export default settings;

package/build-tsc-esm/packageDetect.js

@@ -0,0 +1,3 @@
+import { detectPackage } from '@pezkuwi/util';
+import { packageInfo } from './packageInfo.js';
+detectPackage(packageInfo, null, []);

package/build-tsc-esm/packageInfo.js

@@ -0,0 +1 @@
+export const packageInfo = { name: '@pezkuwi/ui-settings', path: (import.meta && import.meta.url) ? new URL(import.meta.url).pathname.substring(0, new URL(import.meta.url).pathname.lastIndexOf('/') + 1) : 'auto', type: 'esm', version: '3.16.6' };

package/build-tsc-esm/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,37 @@
+{
+  "author": "Jaco Greeff <jacogr@gmail.com>",
+  "bugs": "https://github.com/pezkuwichain/ui/issues",
+  "description": "Manages app settings",
+  "engines": {
+    "node": ">=18"
+  },
+  "homepage": "https://github.com/pezkuwichain/ui/tree/master/packages/ui-settings#readme",
+  "license": "Apache-2.0",
+  "name": "@pezkuwi/ui-settings",
+  "repository": {
+    "directory": "packages/ui-settings",
+    "type": "git",
+    "url": "https://github.com/pezkuwichain/ui.git"
+  },
+  "sideEffects": [
+    "./packageDetect.js",
+    "./packageDetect.cjs"
+  ],
+  "type": "module",
+  "version": "3.16.6",
+  "main": "index.js",
+  "dependencies": {
+    "@pezkuwi/networks": "^14.0.5",
+    "@pezkuwi/util": "^14.0.5",
+    "eventemitter3": "^5.0.1",
+    "store": "^2.0.12",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@types/store": "^2.0.5"
+  },
+  "peerDependencies": {
+    "@pezkuwi/networks": "*",
+    "@pezkuwi/util": "*"
+  }
+}

package/src/Settings.ts

@@ -0,0 +1,236 @@
+// Copyright 2017-2025 @pezkuwi/ui-settings authors & contributors
+// SPDX-License-Identifier: Apache-2.0
+
+import type { Endpoint, EndpointType, Option, SettingsStruct } from './types.js';
+
+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';
+
+type ChangeCallback = (settings: SettingsStruct) => void;
+type OnTypes = 'change';
+
+function withDefault (options: Option[], option: string | undefined, fallback: string): string {
+  const _option = option || fallback;
+
+  return options.some(({ value }) => value === _option)
+    ? _option
+    : fallback;
+}
+
+export class Settings implements SettingsStruct {
+  readonly #emitter: EventEmitter;
+
+  #apiType: Endpoint;
+
+  // will become deprecated for supporting substrate connect light clients. apiType structure should be used instead
+  #apiUrl: string;
+
+  #camera: string;
+
+  #i18nLang: string;
+
+  #icon: string;
+
+  #ledgerApp: string;
+
+  #ledgerConn: string;
+
+  #locking: string;
+
+  #metadataUp: string;
+
+  #prefix: number;
+
+  #storage: string;
+
+  #uiMode: string;
+
+  #uiTheme: string;
+
+  #notification: string;
+
+  constructor () {
+    const settings = (store.get('settings') as SettingsStruct) || {};
+
+    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 as string);
+    this.#apiType = { param: this.#apiUrl, type: 'json-rpc' as EndpointType };
+    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;
+  }
+
+  public get camera (): string {
+    return this.#camera;
+  }
+
+  public get apiType (): Endpoint {
+    return this.#apiType;
+  }
+
+  public get apiUrl (): string {
+    return this.#apiUrl;
+  }
+
+  public get i18nLang (): string {
+    return this.#i18nLang;
+  }
+
+  public get icon (): string {
+    return this.#icon;
+  }
+
+  public get notification (): string {
+    return this.#notification;
+  }
+
+  public get ledgerApp (): string {
+    return this.#ledgerApp;
+  }
+
+  public get ledgerConn (): string {
+    return this.#ledgerConn;
+  }
+
+  public get locking (): string {
+    return this.#locking;
+  }
+
+  public get metadataUp (): string {
+    return this.#metadataUp;
+  }
+
+  public get prefix (): number {
+    return this.#prefix;
+  }
+
+  public get storage (): string {
+    return this.#storage;
+  }
+
+  public get uiMode (): string {
+    return this.#uiMode;
+  }
+
+  public get uiTheme (): string {
+    return this.#uiTheme;
+  }
+
+  public get availableCamera (): Option[] {
+    return CAMERA;
+  }
+
+  public get availableCryptos (): Option[] {
+    return CRYPTOS;
+  }
+
+  public get availableCryptosEth (): Option[] {
+    return CRYPTOS_ETH;
+  }
+
+  public get availableCryptosLedger (): Option[] {
+    return CRYPTOS_LEDGER;
+  }
+
+  public get availableIcons (): Option[] {
+    return ICONS;
+  }
+
+  public get availableLedgerApp (): Option[] {
+    return LEDGER_APP;
+  }
+
+  public get availableLedgerConn (): Option[] {
+    return LEDGER_CONN;
+  }
+
+  public get availableLocking (): Option[] {
+    return LOCKING;
+  }
+
+  public get availableMetadataUp (): Option[] {
+    return METADATA_UP;
+  }
+
+  public get availableNodes (): Option[] {
+    return ENDPOINTS;
+  }
+
+  public get availablePrefixes (): Option[] {
+    return PREFIXES;
+  }
+
+  public get availableStorage (): Option[] {
+    return STORAGE;
+  }
+
+  public get availableUIModes (): Option[] {
+    return UIMODES;
+  }
+
+  public get availableUIThemes (): Option[] {
+    return UITHEMES;
+  }
+
+  public get (): SettingsStruct {
+    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
+    };
+  }
+
+  public set (settings: Partial<SettingsStruct>): void {
+    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);
+  }
+
+  public on (type: OnTypes, cb: ChangeCallback): void {
+    this.#emitter.on(type, cb);
+  }
+}
+
+export const settings = new Settings();