From fbc3d79d98b1326a3dd2a5df0e12c9b961a1fdbc Mon Sep 17 00:00:00 2001 From: getlarge Date: Tue, 15 Feb 2022 14:12:27 +0100 Subject: [PATCH] feat: update connection typedefs --- types/connection.d.ts | 36 +++++++++++++++++++++++++++--------- types/sanitize.d.ts | 6 +++--- 2 files changed, 30 insertions(+), 12 deletions(-) diff --git a/types/connection.d.ts b/types/connection.d.ts index 9dccd0c..75b3771 100644 --- a/types/connection.d.ts +++ b/types/connection.d.ts @@ -19,6 +19,16 @@ export interface InputNode { endpoint: string; } +export type AssetResult = { + id: string; + data: Record; +}; + +export type MetadataResult = { + id: string; + metadata: Record; +}; + export enum Endpoints { blocks = 'blocks', blocksDetail = 'blocksDetail', @@ -76,8 +86,8 @@ export interface EndpointsResponse< [Endpoints.transactionsDetail]: O extends TransactionOperations.CREATE ? CreateTransaction : TransferTransaction; - [Endpoints.assets]: { id: string; data: Record }[]; - [Endpoints.metadata]: { id: string; metadata: Record }[]; + [Endpoints.assets]: AssetResult[]; + [Endpoints.metadata]: MetadataResult[]; } export default class Connection { @@ -111,7 +121,9 @@ export default class Connection { transactionId: string ): Promise[Endpoints.transactionsDetail]>; - listBlocks(transactionId: string): Promise; + listBlocks( + transactionId: string + ): Promise; listOutputs( publicKey: string, @@ -124,7 +136,7 @@ export default class Connection { ): Promise[Endpoints.transactions]>; postTransaction< - O = TransactionOperations.CREATE, + O extends TransactionOperations = TransactionOperations.CREATE, A = Record, M = Record >( @@ -132,7 +144,7 @@ export default class Connection { ): Promise[Endpoints.transactionsCommit]>; postTransactionSync< - O = TransactionOperations.CREATE, + O extends TransactionOperations = TransactionOperations.CREATE, A = Record, M = Record >( @@ -140,7 +152,7 @@ export default class Connection { ): Promise[Endpoints.transactionsSync]>; postTransactionAsync< - O = TransactionOperations.CREATE, + O extends TransactionOperations = TransactionOperations.CREATE, A = Record, M = Record >( @@ -148,14 +160,20 @@ export default class Connection { ): Promise[Endpoints.transactionsAsync]>; postTransactionCommit< - O = TransactionOperations.CREATE, + O extends TransactionOperations = TransactionOperations.CREATE, A = Record, M = Record >( transaction: TransactionCommon ): Promise[Endpoints.transactionsCommit]>; - searchAssets(search: string): Promise; + searchAssets( + search: string, + limit?: number + ): Promise; - searchMetadata(search: string): Promise; + searchMetadata( + search: string, + limit?: number + ): Promise; } diff --git a/types/sanitize.d.ts b/types/sanitize.d.ts index 48ab058..61e29ef 100644 --- a/types/sanitize.d.ts +++ b/types/sanitize.d.ts @@ -6,8 +6,8 @@ declare type FilterFn = (val: any, key?: string) => void; declare function filterFromObject>( obj: I, - filter: Array | FilterFn, - conf: { isInclusion?: boolean } = {} + filter: Array | FilterFn, + conf: { isInclusion?: boolean } ): Partial; declare function applyFilterOnObject>( @@ -17,7 +17,7 @@ declare function applyFilterOnObject>( declare function selectFromObject>( obj: I, - filter: Array | FilterFn + filter: Array | FilterFn ): Partial; export default function sanitize>(