@stacks/stacks-blockchain-api-types - npm Package Compare versions

Comparing version 6.2.0-beta.4 to 6.2.0-beta.5

package.json

 {
   "name": "@stacks/stacks-blockchain-api-types",
-  "version": "6.2.0-beta.4",
+  "version": "6.2.0-beta.5",
   "access": "public",
@@ -5,0 +5,0 @@ "description": "TypeScript descriptions of Stacks 2.0 blockchain API entities",

socket-io/index.d.ts

@@ -27,2 +27,6 @@ import type {
 
+// Allows timeout callbacks for messages. See
+// https://socket.io/docs/v4/typescript/#emitting-with-a-timeout
+type WithTimeoutAck<isSender extends boolean, args extends any[]> = isSender extends true ? [Error, ...args] : args;
+
 export interface ClientToServerMessages {
@@ -33,27 +37,27 @@ subscribe: (topic: Topic | Topic[], callback: (error: string | null) => void) => void;
 
-export interface ServerToClientMessages {
-  block: (block: Block) => void;
-  microblock: (microblock: Microblock) => void;
-  mempool: (transaction: MempoolTransaction) => void;
-  transaction: (transaction: Transaction | MempoolTransaction) => void;
+export interface ServerToClientMessages<isSender extends boolean = false> {
+  block: (block: Block, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  microblock: (microblock: Microblock, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  mempool: (transaction: MempoolTransaction, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  transaction: (transaction: Transaction | MempoolTransaction, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
-  [key: 'nft-event']: (event: NftEvent) => void;
-  'nft-event': (event: NftEvent) => void;
+  [key: 'nft-event']: (event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  'nft-event': (event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
-  [key: NftAssetEventTopic]: (assetIdentifier: string, value: string, event: NftEvent) => void;
-  'nft-asset-event': (assetIdentifier: string, value: string, event: NftEvent) => void;
+  [key: NftAssetEventTopic]: (assetIdentifier: string, value: string, event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  'nft-asset-event': (assetIdentifier: string, value: string, event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
-  [key: NftCollectionEventTopic]: (assetIdentifier: string, event: NftEvent) => void;
-  'nft-collection-event': (assetIdentifier: string, event: NftEvent) => void;
+  [key: NftCollectionEventTopic]: (assetIdentifier: string, event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  'nft-collection-event': (assetIdentifier: string, event: NftEvent, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
-  [key: AddressTransactionTopic]: (address: string, stxBalance: AddressTransactionWithTransfers) => void;
-  'address-transaction': (address: string, tx: AddressTransactionWithTransfers) => void;
+  [key: AddressTransactionTopic]: (address: string, stxBalance: AddressTransactionWithTransfers, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  'address-transaction': (address: string, tx: AddressTransactionWithTransfers, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 
   // @ts-ignore scheduled for support in TS v4.3 https://github.com/microsoft/TypeScript/pull/26797
-  [key: AddressStxBalanceTopic]: (address: string, stxBalance: AddressStxBalanceResponse) => void;
-  'address-stx-balance': (address: string, stxBalance: AddressStxBalanceResponse) => void;
+  [key: AddressStxBalanceTopic]: (address: string, stxBalance: AddressStxBalanceResponse, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
+  'address-stx-balance': (address: string, stxBalance: AddressStxBalanceResponse, callback: (...args: WithTimeoutAck<isSender, [string]>) => void) => void;
 }

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

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

Improved metrics

Total package byte prevSize

538617

increased by0.22%

Lines of code

13010

increased by0.02%

No dependency changes