feat: update connection typedefs

bigchaindb · Feb 15, 2022 · fbc3d79 · fbc3d79
1 parent 46599f5
commit fbc3d79
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 12 deletions.
diff --git 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<string, any>;
+};
+
+export type MetadataResult = {
+  id: string;
+  metadata: Record<string, any>;
+};
+
 export enum Endpoints {
   blocks = 'blocks',
   blocksDetail = 'blocksDetail',
@@ -76,8 +86,8 @@ export interface EndpointsResponse<
   [Endpoints.transactionsDetail]: O extends TransactionOperations.CREATE
     ? CreateTransaction<A, M>
     : TransferTransaction<M>;
-  [Endpoints.assets]: { id: string; data: Record<string, any> }[];
-  [Endpoints.metadata]: { id: string; metadata: Record<string, any> }[];
+  [Endpoints.assets]: AssetResult[];
+  [Endpoints.metadata]: MetadataResult[];
 }
 
 export default class Connection {
@@ -111,7 +121,9 @@ export default class Connection {
     transactionId: string
   ): Promise<EndpointsResponse<O>[Endpoints.transactionsDetail]>;
 
-  listBlocks(transactionId: string): Promise<EndpointsResponse[Endpoints.blocks]>;
+  listBlocks(
+    transactionId: string
+  ): Promise<EndpointsResponse[Endpoints.blocks]>;
 
   listOutputs(
     publicKey: string,
@@ -124,38 +136,44 @@ export default class Connection {
   ): Promise<EndpointsResponse<typeof operation>[Endpoints.transactions]>;
 
   postTransaction<
-    O = TransactionOperations.CREATE,
+    O extends TransactionOperations = TransactionOperations.CREATE,
     A = Record<string, any>,
     M = Record<string, any>
   >(
     transaction: TransactionCommon<O>
   ): Promise<EndpointsResponse<O, A, M>[Endpoints.transactionsCommit]>;
 
   postTransactionSync<
-    O = TransactionOperations.CREATE,
+    O extends TransactionOperations = TransactionOperations.CREATE,
     A = Record<string, any>,
     M = Record<string, any>
   >(
     transaction: TransactionCommon<O>
   ): Promise<EndpointsResponse<O, A, M>[Endpoints.transactionsSync]>;
 
   postTransactionAsync<
-    O = TransactionOperations.CREATE,
+    O extends TransactionOperations = TransactionOperations.CREATE,
     A = Record<string, any>,
     M = Record<string, any>
   >(
     transaction: TransactionCommon<O>
   ): Promise<EndpointsResponse<O, A, M>[Endpoints.transactionsAsync]>;
 
   postTransactionCommit<
-    O = TransactionOperations.CREATE,
+    O extends TransactionOperations = TransactionOperations.CREATE,
     A = Record<string, any>,
     M = Record<string, any>
   >(
     transaction: TransactionCommon<O>
   ): Promise<EndpointsResponse<O, A, M>[Endpoints.transactionsCommit]>;
 
-  searchAssets(search: string): Promise<EndpointsResponse[Endpoints.assets]>;
+  searchAssets(
+    search: string,
+    limit?: number
+  ): Promise<EndpointsResponse[Endpoints.assets]>;
 
-  searchMetadata(search: string): Promise<EndpointsResponse[Endpoints.metadata]>;
+  searchMetadata(
+    search: string,
+    limit?: number
+  ): Promise<EndpointsResponse[Endpoints.metadata]>;
 }
diff --git 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<I = Record<string, any>>(
   obj: I,
-  filter: Array | FilterFn,
-  conf: { isInclusion?: boolean } = {}
+  filter: Array<any> | FilterFn,
+  conf: { isInclusion?: boolean }
 ): Partial<I>;
 
 declare function applyFilterOnObject<I = Record<string, any>>(
@@ -17,7 +17,7 @@ declare function applyFilterOnObject<I = Record<string, any>>(
 
 declare function selectFromObject<I = Record<string, any>>(
   obj: I,
-  filter: Array | FilterFn
+  filter: Array<any> | FilterFn
 ): Partial<I>;
 
 export default function sanitize<I = Record<string, any>>(