Michael Freno
7c684a42cc
- Consolidated duplicate UndoManagers to single instance - Fixed connection promise to only resolve on 'connected' status - Fixed WebSocketProvider import (WebsocketProvider) - Added proper doc.destroy() cleanup - Renamed isPresenceInitialized property to avoid conflict Co-Authored-By: Paperclip <noreply@paperclip.ing>
144 lines
4.3 KiB
TypeScript
144 lines
4.3 KiB
TypeScript
import type { Wallet } from '@wallet-standard/base';
|
|
|
|
/** Name of the feature. */
|
|
export const StandardEvents = 'standard:events';
|
|
/**
|
|
* @deprecated Use {@link StandardEvents} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export const Events = StandardEvents;
|
|
|
|
/**
|
|
* `standard:events` is a {@link "@wallet-standard/base".Wallet.features | feature} that may be implemented by a
|
|
* {@link "@wallet-standard/base".Wallet} to allow the app to add an event listener and subscribe to events emitted by
|
|
* the Wallet when properties of the Wallet {@link StandardEventsListeners.change}.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export type StandardEventsFeature = {
|
|
/** Name of the feature. */
|
|
readonly [StandardEvents]: {
|
|
/** Version of the feature implemented by the {@link "@wallet-standard/base".Wallet}. */
|
|
readonly version: StandardEventsVersion;
|
|
/** Method to call to use the feature. */
|
|
readonly on: StandardEventsOnMethod;
|
|
};
|
|
};
|
|
/**
|
|
* @deprecated Use {@link StandardEventsFeature} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsFeature = StandardEventsFeature;
|
|
|
|
/**
|
|
* Version of the {@link StandardEventsFeature} implemented by a {@link "@wallet-standard/base".Wallet}.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export type StandardEventsVersion = '1.0.0';
|
|
/**
|
|
* @deprecated Use {@link StandardEventsVersion} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsVersion = StandardEventsVersion;
|
|
|
|
/**
|
|
* Method to call to use the {@link StandardEventsFeature}.
|
|
*
|
|
* @param event Event type to listen for. {@link StandardEventsListeners.change | `change`} is the only event type.
|
|
* @param listener Function that will be called when an event of the type is emitted.
|
|
*
|
|
* @return
|
|
* `off` function which may be called to remove the event listener and unsubscribe from events.
|
|
*
|
|
* As with all event listeners, be careful to avoid memory leaks.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export type StandardEventsOnMethod = <E extends StandardEventsNames>(
|
|
event: E,
|
|
listener: StandardEventsListeners[E]
|
|
) => () => void;
|
|
/**
|
|
* @deprecated Use {@link StandardEventsOnMethod} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsOnMethod = StandardEventsOnMethod;
|
|
|
|
/**
|
|
* Types of event listeners of the {@link StandardEventsFeature}.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export interface StandardEventsListeners {
|
|
/**
|
|
* Listener that will be called when {@link StandardEventsChangeProperties | properties} of the
|
|
* {@link "@wallet-standard/base".Wallet} have changed.
|
|
*
|
|
* @param properties Properties that changed with their **new** values.
|
|
*/
|
|
change(properties: StandardEventsChangeProperties): void;
|
|
}
|
|
/**
|
|
* @deprecated Use {@link StandardEventsListeners} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsListeners = StandardEventsListeners;
|
|
|
|
/**
|
|
* Names of {@link StandardEventsListeners} that can be listened for.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export type StandardEventsNames = keyof StandardEventsListeners;
|
|
/**
|
|
* @deprecated Use {@link StandardEventsNames} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsNames = StandardEventsNames;
|
|
|
|
/**
|
|
* Properties of a {@link "@wallet-standard/base".Wallet} that {@link StandardEventsListeners.change | changed} with their
|
|
* **new** values.
|
|
*
|
|
* @group Events
|
|
*/
|
|
export interface StandardEventsChangeProperties {
|
|
/**
|
|
* {@link "@wallet-standard/base".Wallet.chains | Chains} supported by the Wallet.
|
|
*
|
|
* The Wallet should only define this field if the value of the property has changed.
|
|
*
|
|
* The value must be the **new** value of the property.
|
|
*/
|
|
readonly chains?: Wallet['chains'];
|
|
/**
|
|
* {@link "@wallet-standard/base".Wallet.features | Features} supported by the Wallet.
|
|
*
|
|
* The Wallet should only define this field if the value of the property has changed.
|
|
*
|
|
* The value must be the **new** value of the property.
|
|
*/
|
|
readonly features?: Wallet['features'];
|
|
/**
|
|
* {@link "@wallet-standard/base".Wallet.accounts | Accounts} that the app is authorized to use.
|
|
*
|
|
* The Wallet should only define this field if the value of the property has changed.
|
|
*
|
|
* The value must be the **new** value of the property.
|
|
*/
|
|
readonly accounts?: Wallet['accounts'];
|
|
}
|
|
/**
|
|
* @deprecated Use {@link StandardEventsChangeProperties} instead.
|
|
*
|
|
* @group Deprecated
|
|
*/
|
|
export type EventsChangeProperties = StandardEventsChangeProperties;
|