@pezkuwi/extension-base 0.62.8 → 0.62.12

package/src/page/PostMessageProvider.ts

@@ -1,182 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { InjectedProvider, ProviderList, ProviderMeta } from '@pezkuwi/extension-inject/types';
-import type { ProviderInterfaceEmitCb, ProviderInterfaceEmitted } from '@pezkuwi/rpc-provider/types';
-import type { AnyFunction } from '@pezkuwi/types/types';
-import type { SendRequest } from './types.js';
-
-import { EventEmitter } from 'eventemitter3';
-
-import { isUndefined, logger } from '@pezkuwi/util';
-
-const l = logger('PostMessageProvider');
-
-type CallbackHandler = (error?: null | Error, value?: unknown) => void;
-
-// Same as https://github.com/polkadot-js/api/blob/57ca9a9c3204339e1e1f693fcacc33039868dc27/packages/rpc-provider/src/ws/Provider.ts#L17
-interface SubscriptionHandler {
-  callback: CallbackHandler;
-  type: string;
-}
-
-// External to class, this.# is not private enough (yet)
-let sendRequest: SendRequest;
-
-/**
- * @name PostMessageProvider
- *
- * @description Extension provider to be used by dapps
- */
-export default class PostMessageProvider implements InjectedProvider {
-  readonly #eventemitter: EventEmitter;
-
-  // Whether or not the actual extension background provider is connected
-  #isConnected = false;
-
-  // Subscription IDs are (historically) not guaranteed to be globally unique;
-  // only unique for a given subscription method; which is why we identify
-  // the subscriptions based on subscription id + type
-  readonly #subscriptions: Record<string, AnyFunction> = {}; // {[(type,subscriptionId)]: callback}
-
-  /**
-   * @param {function}  sendRequest  The function to be called to send requests to the node
-   * @param {function}  subscriptionNotificationHandler  Channel for receiving subscription messages
-   */
-  public constructor (_sendRequest: SendRequest) {
-    this.#eventemitter = new EventEmitter();
-
-    sendRequest = _sendRequest;
-  }
-
-  public get isClonable (): boolean {
-    return !!true;
-  }
-
-  /**
-   * @description Returns a clone of the object
-   */
-  public clone (): PostMessageProvider {
-    return new PostMessageProvider(sendRequest);
-  }
-
-  /**
-   * @description Manually disconnect from the connection, clearing autoconnect logic
-   */
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async connect (): Promise<void> {
-    // FIXME This should see if the extension's state's provider can disconnect
-    console.error('PostMessageProvider.disconnect() is not implemented.');
-  }
-
-  /**
-   * @description Manually disconnect from the connection, clearing autoconnect logic
-   */
-  // eslint-disable-next-line @typescript-eslint/require-await
-  public async disconnect (): Promise<void> {
-    // FIXME This should see if the extension's state's provider can disconnect
-    console.error('PostMessageProvider.disconnect() is not implemented.');
-  }
-
-  /**
-   * @summary `true` when this provider supports subscriptions
-   */
-  public get hasSubscriptions (): boolean {
-    // FIXME This should see if the extension's state's provider has subscriptions
-    return !!true;
-  }
-
-  /**
-   * @summary Whether the node is connected or not.
-   * @return {boolean} true if connected
-   */
-  public get isConnected (): boolean {
-    return this.#isConnected;
-  }
-
-  public listProviders (): Promise<ProviderList> {
-    return sendRequest('pub(rpc.listProviders)', undefined);
-  }
-
-  /**
-   * @summary Listens on events after having subscribed using the [[subscribe]] function.
-   * @param  {ProviderInterfaceEmitted} type Event
-   * @param  {ProviderInterfaceEmitCb}  sub  Callback
-   * @return unsubscribe function
-   */
-  public on (type: ProviderInterfaceEmitted, sub: ProviderInterfaceEmitCb): () => void {
-    this.#eventemitter.on(type, sub);
-
-    return (): void => {
-      this.#eventemitter.removeListener(type, sub);
-    };
-  }
-
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  public async send (method: string, params: unknown[], _?: boolean, subscription?: SubscriptionHandler): Promise<any> {
-    if (subscription) {
-      const { callback, type } = subscription;
-
-      const id = await sendRequest('pub(rpc.subscribe)', { method, params, type }, (res): void => {
-        subscription.callback(null, res);
-      });
-
-      this.#subscriptions[`${type}::${id}`] = callback;
-
-      return id;
-    }
-
-    return sendRequest('pub(rpc.send)', { method, params });
-  }
-
-  /**
-   * @summary Spawn a provider on the extension background.
-   */
-  public async startProvider (key: string): Promise<ProviderMeta> {
-    // Disconnect from the previous provider
-    this.#isConnected = false;
-    this.#eventemitter.emit('disconnected');
-
-    const meta = await sendRequest('pub(rpc.startProvider)', key);
-
-    // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    sendRequest('pub(rpc.subscribeConnected)', null, (connected) => {
-      this.#isConnected = connected;
-
-      if (connected) {
-        this.#eventemitter.emit('connected');
-      } else {
-        this.#eventemitter.emit('disconnected');
-      }
-
-      return true;
-    });
-
-    return meta;
-  }
-
-  public subscribe (type: string, method: string, params: unknown[], callback: AnyFunction): Promise<number> {
-    return this.send(method, params, false, { callback, type }) as Promise<number>;
-  }
-
-  /**
-   * @summary Allows unsubscribing to subscriptions made with [[subscribe]].
-   */
-  public async unsubscribe (type: string, method: string, id: number): Promise<boolean> {
-    const subscription = `${type}::${id}`;
-
-    // FIXME This now could happen with re-subscriptions. The issue is that with a re-sub
-    // the assigned id now does not match what the API user originally received. It has
-    // a slight complication in solving - since we cannot rely on the send id, but rather
-    // need to find the actual subscription id to map it
-    if (isUndefined(this.#subscriptions[subscription])) {
-      l.debug((): string => `Unable to find active subscription=${subscription}`);
-
-      return false;
-    }
-
-    delete this.#subscriptions[subscription];
-
-    return this.send(method, [id]) as Promise<boolean>;
-  }
-}

package/src/page/Signer.ts

@@ -1,45 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Signer as SignerInterface, SignerResult } from '@pezkuwi/api/types';
-import type { SignerPayloadJSON, SignerPayloadRaw } from '@pezkuwi/types/types';
-import type { SendRequest } from './types.js';
-
-// External to class, this.# is not private enough (yet)
-let sendRequest: SendRequest;
-let nextId = 0;
-
-export default class Signer implements SignerInterface {
-  constructor (_sendRequest: SendRequest) {
-    sendRequest = _sendRequest;
-  }
-
-  public async signPayload (payload: SignerPayloadJSON): Promise<SignerResult> {
-    const id = ++nextId;
-    const result = await sendRequest('pub(extrinsic.sign)', payload);
-
-    // we add an internal id (number) - should have a mapping from the
-    // extension id (string) -> internal id (number) if we wish to provide
-    // updated via the update functionality (noop at this point)
-    return {
-      ...result,
-      id
-    };
-  }
-
-  public async signRaw (payload: SignerPayloadRaw): Promise<SignerResult> {
-    const id = ++nextId;
-    const result = await sendRequest('pub(bytes.sign)', payload);
-
-    return {
-      ...result,
-      id
-    };
-  }
-
-  // NOTE We don't listen to updates at all, if we do we can interpret the
-  // result as provided by the API here
-  // public update (id: number, status: Hash | SubmittableResult): void {
-  //   // ignore
-  // }
-}

package/src/page/index.ts

@@ -1,89 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/* eslint-disable no-redeclare */
-
-import type { MessageTypes, MessageTypesWithNoSubscriptions, MessageTypesWithNullRequest, MessageTypesWithSubscriptions, RequestTypes, ResponseTypes, SubscriptionMessageTypes, TransportRequestMessage, TransportResponseMessage } from '../background/types.js';
-
-import { MESSAGE_ORIGIN_PAGE } from '../defaults.js';
-import { getId } from '../utils/getId.js';
-import Injected from './Injected.js';
-
-// when sending a message from the injector to the extension, we
-//  - create an event - this we send to the loader
-//  - the loader takes this event and uses port.postMessage to background
-//  - on response, the loader creates a response event
-//  - this injector, listens on the events, maps it to the original
-//  - resolves/rejects the promise with the result (or sub data)
-
-export interface Handler {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  resolve: (data?: any) => void;
-  reject: (error: Error) => void;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  subscriber?: (data: any) => void;
-}
-
-export type Handlers = Record<string, Handler>;
-
-const handlers: Handlers = {};
-
-// a generic message sender that creates an event, returning a promise that will
-// resolve once the event is resolved (by the response listener just below this)
-export function sendMessage<TMessageType extends MessageTypesWithNullRequest>(message: TMessageType): Promise<ResponseTypes[TMessageType]>;
-export function sendMessage<TMessageType extends MessageTypesWithNoSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType]): Promise<ResponseTypes[TMessageType]>;
-export function sendMessage<TMessageType extends MessageTypesWithSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType], subscriber: (data: SubscriptionMessageTypes[TMessageType]) => void): Promise<ResponseTypes[TMessageType]>;
-
-export function sendMessage<TMessageType extends MessageTypes> (message: TMessageType, request?: RequestTypes[TMessageType], subscriber?: (data: unknown) => void): Promise<ResponseTypes[TMessageType]> {
-  return new Promise((resolve, reject): void => {
-    const id = getId();
-
-    handlers[id] = { reject, resolve, subscriber };
-
-    const transportRequestMessage: TransportRequestMessage<TMessageType> = {
-      id,
-      message,
-      origin: MESSAGE_ORIGIN_PAGE,
-      request: request || null as RequestTypes[TMessageType]
-    };
-
-    window.postMessage(transportRequestMessage, '*');
-  });
-}
-
-// the enable function, called by the dapp to allow access
-export async function enable (origin: string): Promise<Injected> {
-  await sendMessage('pub(authorize.tab)', { origin });
-
-  return new Injected(sendMessage);
-}
-
-// redirect users if this page is considered as phishing, otherwise return false
-export async function redirectIfPhishing (): Promise<boolean> {
-  const res = await sendMessage('pub(phishing.redirectIfDenied)');
-
-  return res;
-}
-
-export function handleResponse<TMessageType extends MessageTypes> (data: TransportResponseMessage<TMessageType> & { subscription?: string }): void {
-  const handler = handlers[data.id];
-
-  if (!handler) {
-    console.error(`Unknown response: ${JSON.stringify(data)}`);
-
-    return;
-  }
-
-  if (!handler.subscriber) {
-    delete handlers[data.id];
-  }
-
-  if (data.subscription) {
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    (handler.subscriber as Function)(data.subscription);
-  } else if (data.error) {
-    handler.reject(new Error(data.error));
-  } else {
-    handler.resolve(data.response);
-  }
-}

package/src/page/types.ts

@@ -1,10 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { MessageTypesWithNoSubscriptions, MessageTypesWithNullRequest, MessageTypesWithSubscriptions, RequestTypes, ResponseTypes, SubscriptionMessageTypes } from '../background/types.js';
-
-export interface SendRequest {
-  <TMessageType extends MessageTypesWithNullRequest>(message: TMessageType): Promise<ResponseTypes[TMessageType]>;
-  <TMessageType extends MessageTypesWithNoSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType]): Promise<ResponseTypes[TMessageType]>;
-  <TMessageType extends MessageTypesWithSubscriptions>(message: TMessageType, request: RequestTypes[TMessageType], subscriber: (data: SubscriptionMessageTypes[TMessageType]) => void): Promise<ResponseTypes[TMessageType]>;
-}

package/src/stores/Accounts.ts

@@ -1,28 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeyringJson, KeyringStore } from '@pezkuwi/ui-keyring/types';
-
-import { EXTENSION_PREFIX } from '../defaults.js';
-import BaseStore from './Base.js';
-
-export default class AccountsStore extends BaseStore<KeyringJson> implements KeyringStore {
-  constructor () {
-    super(
-      EXTENSION_PREFIX && EXTENSION_PREFIX !== 'polkadot{.js}'
-        ? `${EXTENSION_PREFIX}accounts`
-        : null
-    );
-  }
-
-  public override async set (key: string, value: KeyringJson, update?: () => void): Promise<void> {
-    // shortcut, don't save testing accounts in extension storage
-    if (key.startsWith('account:') && value.meta && value.meta.isTesting) {
-      update && update();
-
-      return;
-    }
-
-    await super.set(key, value, update);
-  }
-}

package/src/stores/Base.ts

@@ -1,93 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-/* global chrome */
-
-type StoreValue = Record<string, unknown>;
-
-const lastError = (type: string): void => {
-  const error = chrome.runtime.lastError;
-
-  if (error) {
-    console.error(`BaseStore.${type}:: runtime.lastError:`, error);
-  }
-};
-
-export default abstract class BaseStore <T> {
-  #prefix: string;
-
-  constructor (prefix: string | null) {
-    this.#prefix = prefix ? `${prefix}:` : '';
-  }
-
-  public async all (update: (key: string, value: T) => void): Promise<void> {
-    await this.allMap(async (map): Promise<void> => {
-      const entries = Object.entries(map);
-
-      for (const [key, value] of entries) {
-        // eslint-disable-next-line @typescript-eslint/await-thenable
-        await update(key, value);
-      }
-    });
-  }
-
-  public async allMap (update: (value: Record<string, T>) => Promise<void>): Promise<void> {
-    await chrome.storage.local.get(null).then(async (result: StoreValue) => {
-      lastError('all');
-
-      const entries = Object.entries(result);
-      const map: Record<string, T> = {};
-
-      for (let i = 0, count = entries.length; i < count; i++) {
-        const [key, value] = entries[i];
-
-        if (key.startsWith(this.#prefix)) {
-          map[key.replace(this.#prefix, '')] = value as T;
-        }
-      }
-
-      await update(map);
-    }).catch(({ message }: Error) => {
-      console.error(`BaseStore error within allMap: ${message}`);
-    });
-  }
-
-  public async get (key: string, update: (value: T) => void): Promise<void> {
-    const prefixedKey = `${this.#prefix}${key}`;
-
-    await chrome.storage.local.get([prefixedKey]).then(async (result: StoreValue) => {
-      lastError('get');
-
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      await update(result[prefixedKey] as T);
-    }).catch(({ message }: Error) => {
-      console.error(`BaseStore error within get: ${message}`);
-    });
-  }
-
-  public async remove (key: string, update?: () => void): Promise<void> {
-    const prefixedKey = `${this.#prefix}${key}`;
-
-    await chrome.storage.local.remove(prefixedKey).then(async () => {
-      lastError('remove');
-
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      update && await update();
-    }).catch(({ message }: Error) => {
-      console.error(`BaseStore error within remove: ${message}`);
-    });
-  }
-
-  public async set (key: string, value: T, update?: () => void): Promise<void> {
-    const prefixedKey = `${this.#prefix}${key}`;
-
-    await chrome.storage.local.set({ [prefixedKey]: value }).then(async () => {
-      lastError('set');
-
-      // eslint-disable-next-line @typescript-eslint/await-thenable
-      update && await update();
-    }).catch(({ message }: Error) => {
-      console.error(`BaseStore error within set: ${message}`);
-    });
-  }
-}

package/src/stores/Metadata.ts

@@ -1,17 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { MetadataDef } from '@pezkuwi/extension-inject/types';
-
-import { EXTENSION_PREFIX } from '../defaults.js';
-import BaseStore from './Base.js';
-
-export default class MetadataStore extends BaseStore<MetadataDef> {
-  constructor () {
-    super(
-      EXTENSION_PREFIX && EXTENSION_PREFIX !== 'polkadot{.js}'
-        ? `${EXTENSION_PREFIX}metadata`
-        : 'metadata'
-    );
-  }
-}

package/src/types.ts

@@ -1,12 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export interface Message extends MessageEvent {
-  data: {
-    error?: string;
-    id: string;
-    origin: string;
-    response?: string;
-    subscription?: string;
-  }
-}

package/src/utils/canDerive.ts

@@ -1,8 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { KeypairType } from '@pezkuwi/util-crypto/types';
-
-export function canDerive (type?: KeypairType): boolean {
-  return !!type && ['ed25519', 'sr25519', 'ecdsa', 'ethereum'].includes(type);
-}

package/src/utils/getId.ts

@@ -1,10 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import { EXTENSION_PREFIX } from '../defaults.js';
-
-let counter = 0;
-
-export function getId (): string {
-  return `${EXTENSION_PREFIX}.${Date.now()}.${++counter}`;
-}

package/src/utils/index.ts

@@ -1,4 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-export { canDerive } from './canDerive.js';

package/src/utils/portUtils.ts

@@ -1,65 +0,0 @@
-// Copyright 2019-2025 @pezkuwi/extension-base authors & contributors
-// SPDX-License-Identifier: Apache-2.0
-
-import type { Message } from '@pezkuwi/extension-base/types';
-
-import { chrome } from '@pezkuwi/extension-inject/chrome';
-
-export function setupPort (portName: string, onMessageHandler: (data: Message['data']) => void, onDisconnectHandler: () => void): chrome.runtime.Port {
-  const port = chrome.runtime.connect({ name: portName });
-
-  port.onMessage.addListener(onMessageHandler);
-
-  port.onDisconnect.addListener(() => {
-    console.log(`Disconnected from ${portName}`);
-    onDisconnectHandler();
-  });
-
-  return port;
-}
-
-export async function wakeUpServiceWorker (): Promise<{ status: string }> {
-  return new Promise((resolve, reject) => {
-    chrome.runtime.sendMessage({ type: 'wakeup' }, (response: { status: string }) => {
-      if (chrome.runtime.lastError) {
-        reject(new Error(chrome.runtime.lastError.message));
-      } else {
-        resolve(response);
-      }
-    });
-  });
-}
-
-// This object is required to allow jest.spyOn to be used to create a mock Implementation for testing
-export const wakeUpServiceWorkerWrapper = { wakeUpServiceWorker };
-
-export async function ensurePortConnection (
-  portRef: chrome.runtime.Port | undefined,
-  portConfig: {
-    portName: string,
-    onPortMessageHandler: (data: Message['data']) => void,
-    onPortDisconnectHandler: () => void
-  }
-): Promise<chrome.runtime.Port> {
-  const maxAttempts = 5;
-  const delayMs = 1000;
-
-  for (let attempt = 0; attempt < maxAttempts; attempt++) {
-    try {
-      const response = await wakeUpServiceWorkerWrapper.wakeUpServiceWorker();
-
-      if (response?.status === 'awake') {
-        if (!portRef) {
-          return setupPort(portConfig.portName, portConfig.onPortMessageHandler, portConfig.onPortDisconnectHandler);
-        }
-
-        return portRef;
-      }
-    } catch (error) {
-      console.error(`Attempt ${attempt + 1} failed: ${(error as Error).message}`);
-      await new Promise((resolve) => setTimeout(resolve, delayMs));
-    }
-  }
-
-  throw new Error('Failed to wake up the service worker and setup the port after multiple attempts');
-}

package/tsconfig.build.json

@@ -1,16 +0,0 @@
-{
-  "extends": "../../tsconfig.base.json",
-  "compilerOptions": {
-    "baseUrl": "..",
-    "outDir": "./build",
-    "rootDir": "./src"
-  },
-  "exclude": [
-    "**/*.spec.ts"
-  ],
-  "references": [
-    { "path": "../extension-chains/tsconfig.build.json" },
-    { "path": "../extension-dapp/tsconfig.build.json" },
-    { "path": "../extension-inject/tsconfig.build.json" }
-  ]
-}