@web3-react/types - npm Package Compare versions

Comparing version 8.0.16-alpha.0 to 8.0.16-beta.0

dist/index.d.ts

 /// <reference types="node" />
 import type { EventEmitter } from 'node:events';
-import type { State, StoreApi } from 'zustand/vanilla';
+import type { State, StoreApi } from 'zustand';
 export interface Web3ReactState extends State {
@@ -11,6 +11,12 @@ chainId: number | undefined;
 export declare type Web3ReactStore = StoreApi<Web3ReactState>;
-export interface Web3ReactStateUpdate {
-    chainId?: number;
-    accounts?: string[];
-}
+export declare type Web3ReactStateUpdate = {
+    chainId: number;
+    accounts: string[];
+} | {
+    chainId: number;
+    accounts?: never;
+} | {
+    chainId?: never;
+    accounts: string[];
+};
 export interface Actions {
@@ -36,12 +42,58 @@ startActivation: () => () => void;
 }
-export interface ProviderMessage {
-    readonly type: string;
-    readonly data: unknown;
+export interface AddEthereumChainParameter {
+    chainId: number;
+    chainName: string;
+    nativeCurrency: {
+        name: string;
+        symbol: string;
+        decimals: 18;
+    };
+    rpcUrls: string[];
+    blockExplorerUrls?: string[];
+    iconUrls?: string[];
 }
+export interface WatchAssetParameters {
+    address: string;
+    symbol: string;
+    decimals: number;
+    image: string;
+}
 export declare abstract class Connector {
+    /**
+     * An
+     * EIP-1193 ({@link https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1193.md}) and
+     * EIP-1102 ({@link https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md}) compliant provider.
+     * May also comply with EIP-3085 ({@link https://github.com/ethereum/EIPs/blob/master/EIPS/eip-3085.md}).
+     * This property must be defined while the connector is active, unless a customProvider is provided.
+     */
     provider: Provider | undefined;
+    /**
+     * An optional property meant to allow ethers providers to be used directly rather than via the experimental
+     * 1193 bridge. If desired, this property must be defined while the connector is active, in which case it will
+     * be preferred over provider.
+     */
+    customProvider: unknown | undefined;
     protected readonly actions: Actions;
+    /**
+     * @param actions - Methods bound to a zustand store that tracks the state of the connector.
+     * Actions are used by the connector to report changes in connection status.
+     */
     constructor(actions: Actions);
+    protected get serverSide(): boolean;
+    /**
+     * Attempt to initiate a connection, failing silently
+     */
+    connectEagerly?(...args: unknown[]): Promise<void> | void;
+    /**
+     * Initiate a connection.
+     */
     abstract activate(...args: unknown[]): Promise<void> | void;
-    deactivate?(...args: unknown[]): Promise<void> | void;
+    /**
+     * Initiate a disconnect.
+     */
+    deactivate(...args: unknown[]): Promise<void> | void;
+    /**
+     * Attempt to add an asset per EIP-747
+     */
+    watchAsset?(params: WatchAssetParameters): Promise<boolean>;
 }

dist/index.js

@@ -1,5 +0,23 @@
-export class Connector {
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Connector = void 0;
+class Connector {
+    /**
+     * @param actions - Methods bound to a zustand store that tracks the state of the connector.
+     * Actions are used by the connector to report changes in connection status.
+     */
     constructor(actions) {
         this.actions = actions;
     }
+    get serverSide() {
+        return typeof window === 'undefined';
+    }
+    /**
+     * Initiate a disconnect.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    deactivate(...args) {
+        this.actions.reportError(undefined);
+    }
 }
+exports.Connector = Connector;

package.json

 {
   "name": "@web3-react/types",
+  "keywords": [
+    "web3-react"
+  ],
+  "author": "Noah Zinsmeister <[e-mail]>",
+  "license": "GPL-3.0-or-later",
+  "repository": "github:NoahZinsmeister/web3-react",
   "publishConfig": {
     "access": "public"
   },
-  "version": "8.0.16-alpha.0",
-  "type": "module",
+  "version": "8.0.16-beta.0",
   "files": [
     "dist/*"
   ],
-  "exports": {
-    "types": "./dist/index.d.ts",
-    "import": "./dist/index.js",
-    "require": "./dist/cjs/index.js"
-  },
+  "type": "commonjs",
   "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "main": "./dist/cjs/index.js",
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
   "scripts": {
     "prebuild": "rm -rf dist",
-    "build": "tsc && tsc --project tsconfig.cjs.json",
+    "build": "tsc",
     "start": "tsc --watch"
   },
   "dependencies": {
-    "zustand": "^4.0.0-beta.0"
+    "zustand": "^4.0.0-rc.0"
   },
-  "gitHead": "9d184f0d5d21a0dd48abc799df65a822d8c0c916"
+  "gitHead": "771af6b38c16be09256570bc20fb4ef1578762c0"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

39654

increased by5.72%

Lines of code

120

increased by103.39%

Number of low maintenance alerts

1

decreased by-50%

Number of medium quality alerts

0

decreased by-100%

Number of lines in readme file

2

increased byInfinity%

Worsened metrics

Number of low license alerts

3

increased by50%

Is type module

No

Dependency changes

• Updatedzustand@^4.0.0-rc.0