response adapter types. (#842)

packages/apiUtils/scripts/generate-client.js

@@ -31,8 +31,7 @@ for (const groupName of uniqueGroupNames) {
   for (const operation of package.operations.filter((o) => o.groupName === groupName)) {
     const operationVarName = `${operation.name}Operation`;
     const requestClassName = `${capitalizeFirst(operation.name)}Request`;
-    const responseClassName = `${capitalizeFirst(operation.name)}Response`;
-    const jsonResponseClassName = `${capitalizeFirst(operation.name)}JSONResponse`;
+    const responseClassName = `${capitalizeFirst(operation.name)}ResponseAdapter`;
 
     const omitRequest = !operation?.urlPathParamNames && !operation.urlSearchParamNames && !operation.bodyParamNames;
 
@@ -41,15 +40,15 @@ for (const groupName of uniqueGroupNames) {
     switch (determineOperationType(operation)) {
       case 'nonNullable':
         resolverClassName = 'OperationResolver';
-        returnType = `ResponseAdapter<${responseClassName}, ${jsonResponseClassName}>`;
+        returnType = responseClassName;
         break;
       case 'nullable':
         resolverClassName = 'NullableOperationResolver';
-        returnType = `ResponseAdapter<${responseClassName}, ${jsonResponseClassName}> | null`;
+        returnType = `${responseClassName} | null`;
         break;
       case 'paginated':
         resolverClassName = 'PaginatedOperationResolver';
-        returnType = `PaginatedResponseAdapter<${responseClassName}, ${jsonResponseClassName}['result']>`;
+        returnType = responseClassName;
         break;
     }
 
@@ -58,9 +57,7 @@ for (const groupName of uniqueGroupNames) {
       sourcePackageImports.add(requestClassName);
     }
     sourcePackageImports.add(responseClassName);
-    sourcePackageImports.add(jsonResponseClassName);
     apiUtilsPackageImports.add(resolverClassName);
-    corePackageImports.add(returnType.split('<')[0]);
 
     bodyOutput += `   ${operation.name}: (${
       omitRequest ? '' : `request: ${requestClassName}`

packages/client/apiUtils/scripts/generate-client.js

@@ -19,7 +19,6 @@ const { determineOperationType } = require('@moralisweb3/common-core');
 
 const uniqueGroupNames = new Set(package.operations.map((o) => o.groupName));
 const sourcePackageImports = new Set();
-const corePackageImports = new Set();
 let bodyOutput = ``;
 
 for (const groupName of uniqueGroupNames) {
@@ -30,31 +29,28 @@ for (const groupName of uniqueGroupNames) {
   for (const operation of package.operations.filter((o) => o.groupName === groupName)) {
     const operationVarName = `${operation.name}Operation`;
     const requestClassName = `${capitalizeFirst(operation.name)}Request`;
-    const responseClassName = `${capitalizeFirst(operation.name)}Response`;
-    const jsonResponseClassName = `${capitalizeFirst(operation.name)}JSONResponse`;
+    const responseClassName = `${capitalizeFirst(operation.name)}ResponseAdapter`;
 
     let methodName;
     let returnType;
     switch (determineOperationType(operation)) {
       case 'nonNullable':
         methodName = 'handle';
-        returnType = `ResponseAdapter<${responseClassName}, ${jsonResponseClassName}>`;
+        returnType = responseClassName;
         break;
       case 'nullable':
         methodName = 'handleNullable';
-        returnType = `ResponseAdapter<${responseClassName}, ${jsonResponseClassName}> | null`;
+        returnType = `${responseClassName} | null`;
         break;
       case 'paginated':
         methodName = 'handlePaginated';
-        returnType = `PaginatedResponseAdapter<${responseClassName}, ${jsonResponseClassName}['result']>`;
+        returnType = responseClassName;
         break;
     }
 
     sourcePackageImports.add(operationVarName);
     sourcePackageImports.add(requestClassName);
     sourcePackageImports.add(responseClassName);
-    sourcePackageImports.add(jsonResponseClassName);
-    corePackageImports.add(returnType.split('<')[0]);
 
     bodyOutput += `   ${operation.name}: (request: ${requestClassName}): Promise<${returnType}> => {
       return this.requestHandler.${methodName}(request, ${operationVarName});
@@ -72,7 +68,6 @@ const output = `
 
 import { ${[...sourcePackageImports].join(', ')} } from '${sourcePackageName}';
 import { ClientRequestHandler } from '@moralisweb3/client-api-utils';
-import { ${[...corePackageImports].join(', ')} } from '@moralisweb3/common-core';
 
 export class ${outputClassName} {
   public constructor(

packages/client/solApi/src/generated/ClientSolApi.ts

@@ -1,40 +1,39 @@
 
 // CAUTION: This file is automatically generated. Do not edit it manually!
 
-import { getBalanceOperation, GetBalanceRequest, GetBalanceResponse, GetBalanceJSONResponse, getNFTsOperation, GetNFTsRequest, GetNFTsResponse, GetNFTsJSONResponse, getPortfolioOperation, GetPortfolioRequest, GetPortfolioResponse, GetPortfolioJSONResponse, getSPLOperation, GetSPLRequest, GetSPLResponse, GetSPLJSONResponse, getNFTMetadataOperation, GetNFTMetadataRequest, GetNFTMetadataResponse, GetNFTMetadataJSONResponse, getTokenPriceOperation, GetTokenPriceRequest, GetTokenPriceResponse, GetTokenPriceJSONResponse } from '@moralisweb3/common-sol-utils';
+import { getBalanceOperation, GetBalanceRequest, GetBalanceResponseAdapter, getNFTsOperation, GetNFTsRequest, GetNFTsResponseAdapter, getPortfolioOperation, GetPortfolioRequest, GetPortfolioResponseAdapter, getSPLOperation, GetSPLRequest, GetSPLResponseAdapter, getNFTMetadataOperation, GetNFTMetadataRequest, GetNFTMetadataResponseAdapter, getTokenPriceOperation, GetTokenPriceRequest, GetTokenPriceResponseAdapter } from '@moralisweb3/common-sol-utils';
 import { ClientRequestHandler } from '@moralisweb3/client-api-utils';
-import { ResponseAdapter } from '@moralisweb3/common-core';
 
 export class ClientSolApi {
   public constructor(
     private readonly requestHandler: ClientRequestHandler) {
   }
 
   public readonly account = {
-   getBalance: (request: GetBalanceRequest): Promise<ResponseAdapter<GetBalanceResponse, GetBalanceJSONResponse>> => {
+   getBalance: (request: GetBalanceRequest): Promise<GetBalanceResponseAdapter> => {
       return this.requestHandler.handle(request, getBalanceOperation);
     },
-   getNFTs: (request: GetNFTsRequest): Promise<ResponseAdapter<GetNFTsResponse, GetNFTsJSONResponse>> => {
+   getNFTs: (request: GetNFTsRequest): Promise<GetNFTsResponseAdapter> => {
       return this.requestHandler.handle(request, getNFTsOperation);
     },
-   getPortfolio: (request: GetPortfolioRequest): Promise<ResponseAdapter<GetPortfolioResponse, GetPortfolioJSONResponse>> => {
+   getPortfolio: (request: GetPortfolioRequest): Promise<GetPortfolioResponseAdapter> => {
       return this.requestHandler.handle(request, getPortfolioOperation);
     },
-   getSPL: (request: GetSPLRequest): Promise<ResponseAdapter<GetSPLResponse, GetSPLJSONResponse>> => {
+   getSPL: (request: GetSPLRequest): Promise<GetSPLResponseAdapter> => {
       return this.requestHandler.handle(request, getSPLOperation);
     },
 
   };
 
   public readonly nft = {
-   getNFTMetadata: (request: GetNFTMetadataRequest): Promise<ResponseAdapter<GetNFTMetadataResponse, GetNFTMetadataJSONResponse>> => {
+   getNFTMetadata: (request: GetNFTMetadataRequest): Promise<GetNFTMetadataResponseAdapter> => {
       return this.requestHandler.handle(request, getNFTMetadataOperation);
     },
 
   };
 
   public readonly token = {
-   getTokenPrice: (request: GetTokenPriceRequest): Promise<ResponseAdapter<GetTokenPriceResponse, GetTokenPriceJSONResponse>> => {
+   getTokenPrice: (request: GetTokenPriceRequest): Promise<GetTokenPriceResponseAdapter> => {
       return this.requestHandler.handle(request, getTokenPriceOperation);
     },
 

packages/common/evmUtils/src/operations/balance/getNativeBalanceOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, maybe } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, maybe, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNative } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +24,9 @@ export type GetNativeBalanceJSONResponse = SuccessResponse;
 
 export type GetNativeBalanceResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNativeBalanceResponseAdapter
+  extends ResponseAdapter<GetNativeBalanceResponse, GetNativeBalanceJSONResponse> {}
+
 export const getNativeBalanceOperation: Operation<
   GetNativeBalanceRequest,
   GetNativeBalanceJSONRequest,

packages/common/evmUtils/src/operations/block/getBlockOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, toCamelCase } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, toCamelCase, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmBlock, EvmChain, EvmChainish, EvmTransaction, EvmTransactionLog, LogTopic } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -23,6 +23,8 @@ export type GetBlockJSONResponse = SuccessResponse;
 
 export type GetBlockResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetBlockResponseAdapter extends ResponseAdapter<GetBlockResponse, GetBlockJSONResponse> {}
+
 export const getBlockOperation: Operation<
   GetBlockRequest,
   GetBlockJSONRequest,

packages/common/evmUtils/src/operations/block/getDateToBlockOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, DateInput } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, DateInput, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +24,9 @@ export type GetDateToBlockJSONResponse = SuccessResponse;
 
 export type GetDateToBlockResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetDateToBlockResponseAdapter
+  extends ResponseAdapter<GetDateToBlockResponse, GetDateToBlockJSONResponse> {}
+
 export const getDateToBlockOperation: Operation<
   GetDateToBlockRequest,
   GetDateToBlockJSONRequest,

packages/common/evmUtils/src/operations/defi/getPairAddressOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, DateInput } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, DateInput, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, Erc20Token } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -27,6 +27,9 @@ export type GetPairAddressJSONResponse = SuccessResponse;
 
 export type GetPairAddressResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetPairAddressResponseAdapter
+  extends ResponseAdapter<GetPairAddressResponse, GetPairAddressJSONResponse> {}
+
 export const getPairAddressOperation: Operation<
   GetPairAddressRequest,
   GetPairAddressJSONRequest,

packages/common/evmUtils/src/operations/defi/getPairReservesOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, DateInput } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, DateInput, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -25,6 +25,9 @@ export type GetPairReservesJSONResponse = SuccessResponse;
 
 export type GetPairReservesResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetPairReservesResponseAdapter
+  extends ResponseAdapter<GetPairReservesResponse, GetPairReservesJSONResponse> {}
+
 export const getPairReservesOperation: Operation<
   GetPairReservesRequest,
   GetPairReservesJSONRequest,

packages/common/evmUtils/src/operations/events/getContractEventsOperation.ts

@@ -1,4 +1,11 @@
-import { Core, Camelize, PaginatedOperation, maybe, DateInput } from '@moralisweb3/common-core';
+import {
+  Core,
+  Camelize,
+  PaginatedOperation,
+  maybe,
+  DateInput,
+  PaginatedResponseAdapter,
+} from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmEvent } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -28,6 +35,9 @@ export type GetContractEventsJSONResponse = SuccessResponse;
 
 export type GetContractEventsResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetContractEventsResponseAdapter
+  extends PaginatedResponseAdapter<GetContractEventsResponse, GetContractEventsJSONResponse['result']> {}
+
 export const getContractEventsOperation: PaginatedOperation<
   GetContractEventsRequest,
   GetContractEventsJSONRequest,

packages/common/evmUtils/src/operations/events/getContractLogsOperation.ts

@@ -1,4 +1,12 @@
-import { Core, Camelize, PaginatedOperation, maybe, DateInput, toCamelCase } from '@moralisweb3/common-core';
+import {
+  Core,
+  Camelize,
+  PaginatedOperation,
+  maybe,
+  DateInput,
+  toCamelCase,
+  PaginatedResponseAdapter,
+} from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmTransactionLog, LogTopic } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -27,6 +35,9 @@ export type GetContractLogsJSONResponse = SuccessResponse;
 
 export type GetContractLogsResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetContractLogsResponseAdapter
+  extends PaginatedResponseAdapter<GetContractLogsResponse, GetContractLogsJSONResponse['result']> {}
+
 export const getContractLogsOperation: PaginatedOperation<
   GetContractLogsRequest,
   GetContractLogsJSONRequest,

packages/common/evmUtils/src/operations/ipfs/uploadFolderOperation.ts

@@ -1,4 +1,4 @@
-import { Operation } from '@moralisweb3/common-core';
+import { Operation, ResponseAdapter } from '@moralisweb3/common-core';
 
 import { operations } from '../openapi';
 
@@ -22,6 +22,8 @@ export type UploadFolderJSONResponse = SuccessResponse;
 
 export type UploadFolderResponse = ReturnType<typeof deserializeResponse>;
 
+export interface UploadFolderResponseAdapter extends ResponseAdapter<UploadFolderResponse, UploadFolderJSONResponse> {}
+
 export const uploadFolderOperation: Operation<
   UploadFolderRequest,
   UploadFolderJSONRequest,

packages/common/evmUtils/src/operations/nft/getContractNFTsOperation.ts

@@ -1,4 +1,11 @@
-import { Core, Camelize, PaginatedOperation, toCamelCase, maybe } from '@moralisweb3/common-core';
+import {
+  Core,
+  Camelize,
+  PaginatedOperation,
+  toCamelCase,
+  maybe,
+  PaginatedResponseAdapter,
+} from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNft } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +31,9 @@ export type GetContractNFTsJSONResponse = SuccessResponse;
 
 export type GetContractNFTsResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetContractNFTsResponseAdapter
+  extends PaginatedResponseAdapter<GetContractNFTsResponse, GetContractNFTsJSONResponse['result']> {}
+
 export const getContractNFTsOperation: PaginatedOperation<
   GetContractNFTsRequest,
   GetContractNFTsJSONRequest,

packages/common/evmUtils/src/operations/nft/getNFTContractMetadataOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, toCamelCase, maybe } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, toCamelCase, maybe, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNftMetadata } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +24,9 @@ export type GetNFTContractMetadataJSONResponse = SuccessResponse;
 
 export type GetNFTContractMetadataResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNFTContractMetadataResponseAdapter
+  extends ResponseAdapter<GetNFTContractMetadataResponse, GetNFTContractMetadataJSONResponse> {}
+
 export const getNFTContractMetadataOperation: Operation<
   GetNFTContractMetadataRequest,
   GetNFTContractMetadataJSONRequest,

packages/common/evmUtils/src/operations/nft/getNFTContractTransfersOperation.ts

@@ -1,4 +1,11 @@
-import { Core, Camelize, PaginatedOperation, toCamelCase, maybe } from '@moralisweb3/common-core';
+import {
+  Core,
+  Camelize,
+  PaginatedOperation,
+  toCamelCase,
+  maybe,
+  PaginatedResponseAdapter,
+} from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNftTransfer, EvmNative } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +31,9 @@ export type GetNFTContractTransfersJSONResponse = SuccessResponse;
 
 export type GetNFTContractTransfersResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNFTContractTransfersResponseAdapter
+  extends PaginatedResponseAdapter<GetNFTContractTransfersResponse, GetNFTContractTransfersJSONResponse['result']> {}
+
 export const getNFTContractTransfersOperation: PaginatedOperation<
   GetNFTContractTransfersRequest,
   GetNFTContractTransfersJSONRequest,

packages/common/evmUtils/src/operations/nft/getNFTLowestPriceOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, toCamelCase, maybe } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, toCamelCase, maybe, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNftTrade, EvmNative } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +24,9 @@ export type GetNFTLowestPriceJSONResponse = SuccessResponse;
 
 export type GetNFTLowestPriceResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNFTLowestPriceResponseAdapter
+  extends ResponseAdapter<GetNFTLowestPriceResponse, GetNFTLowestPriceJSONResponse> {}
+
 export const getNFTLowestPriceOperation: Operation<
   GetNFTLowestPriceRequest,
   GetNFTLowestPriceJSONRequest,

packages/common/evmUtils/src/operations/nft/getNFTMetadataOperation.ts

@@ -1,4 +1,4 @@
-import { Core, Camelize, Operation, toCamelCase } from '@moralisweb3/common-core';
+import { Core, Camelize, Operation, toCamelCase, ResponseAdapter } from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNft } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +24,9 @@ export type GetNFTMetadataJSONResponse = SuccessResponse;
 
 export type GetNFTMetadataResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNFTMetadataResponseAdapter
+  extends ResponseAdapter<GetNFTMetadataResponse, GetNFTMetadataJSONResponse> {}
+
 export const getNFTMetadataOperation: Operation<
   GetNFTMetadataRequest,
   GetNFTMetadataJSONRequest,

packages/common/evmUtils/src/operations/nft/getNFTOwnersOperation.ts

@@ -1,4 +1,11 @@
-import { Core, Camelize, PaginatedOperation, toCamelCase, maybe } from '@moralisweb3/common-core';
+import {
+  Core,
+  Camelize,
+  PaginatedOperation,
+  toCamelCase,
+  maybe,
+  PaginatedResponseAdapter,
+} from '@moralisweb3/common-core';
 import { EvmChain, EvmChainish, EvmAddress, EvmAddressish, EvmNft } from '../../dataTypes';
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
@@ -24,6 +31,9 @@ export type GetNFTOwnersJSONResponse = SuccessResponse;
 
 export type GetNFTOwnersResponse = ReturnType<typeof deserializeResponse>;
 
+export interface GetNFTOwnersResponseAdapter
+  extends PaginatedResponseAdapter<GetNFTOwnersResponse, GetNFTOwnersJSONResponse['result']> {}
+
 export const getNFTOwnersOperation: PaginatedOperation<
   GetNFTOwnersRequest,
   GetNFTOwnersJSONRequest,