add id to Operation interface. (#779)

* add id to Operation interface.
MoralisWeb3 · Oct 27, 2022 · 23b3a61 · 23b3a61 · github-actions · Oct 27, 2022
1 parent 5b27ae8
commit 23b3a61
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 42 deletions.
diff --git a/packages/apiUtils/src/resolvers2/OperationRequestBuilder.test.ts b/packages/apiUtils/src/resolvers2/OperationRequestBuilder.test.ts
@@ -10,6 +10,7 @@ export interface TestRequest {
 
 const operation: Operation<TestRequest, unknown, unknown, unknown> = {
   name: 'test',
+  id: 'test',
   groupName: 'test',
   method: 'POST',
   urlPathParamNames: ['userId'],

diff --git a/packages/common/core/src/operations/Operation.ts b/packages/common/core/src/operations/Operation.ts
@@ -2,6 +2,7 @@ import { Core } from '../Core';
 
 export interface Operation<Request, JSONRequest, Response, JSONResponse> {
   name: string;
+  id: string;
   groupName: string;
   method: OperationRequestMethod;
   urlPathPattern: string;

diff --git a/packages/common/evmUtils/src/operations/operations.test.ts b/packages/common/evmUtils/src/operations/operations.test.ts
@@ -11,9 +11,9 @@ describe('operations', () => {
 
   for (const operation of operations) {
     it(`${operation.name} defines all supported parameters`, () => {
-      const openApiPathParamNames = reader.readOperationPathParamNames(operation.name);
-      const openApiSearchParamNames = reader.readOperationSearchParamNames(operation.name)?.map(toCamel);
-      const openApiBodyParamNames = reader.readOperationRequestBodyParamNames(operation.name)?.map(toCamel);
+      const openApiPathParamNames = reader.readOperationPathParamNames(operation.id);
+      const openApiSearchParamNames = reader.readOperationSearchParamNames(operation.id)?.map(toCamel);
+      const openApiBodyParamNames = reader.readOperationRequestBodyParamNames(operation.id)?.map(toCamel);
 
       expect(operation.urlPathParamNames.sort().join(',')).toBe(openApiPathParamNames?.sort().join(','));
       expect(operation.urlSearchParamNames?.sort().join(',')).toBe(openApiSearchParamNames?.sort().join(','));

diff --git a/packages/common/evmUtils/src/operations/token/getWalletTokenTransfersOperation.test.ts b/packages/common/evmUtils/src/operations/token/getWalletTokenTransfersOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { EvmAddress, EvmChain } from '../../dataTypes';
 import { getWalletTokenTransfersOperation, GetWalletTokenTransfersRequest } from './getWalletTokenTransfersOperation';
 

diff --git a/packages/common/evmUtils/src/operations/token/getWalletTokenTransfersOperation.ts b/packages/common/evmUtils/src/operations/token/getWalletTokenTransfersOperation.ts
@@ -3,10 +3,10 @@ import { Erc20Transfer, EvmAddress, EvmAddressish, EvmChain, EvmChainish } from
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getWalletTokenTransfers';
-type PathParams = operations[OperationName]['parameters']['path'];
-type QueryParams = operations[OperationName]['parameters']['query'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getWalletTokenTransfers';
+type PathParams = operations[OperationId]['parameters']['path'];
+type QueryParams = operations[OperationId]['parameters']['query'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -29,6 +29,7 @@ export const getWalletTokenTransfersOperation: PaginatedOperation<
 > = {
   method: 'GET',
   name: 'getWalletTokenTransfers',
+  id: 'getWalletTokenTransfers',
   groupName: 'token',
   urlPathParamNames: ['address'],
   urlSearchParamNames: ['chain', 'cursor', 'fromBlock', 'fromDate', 'limit', 'subdomain', 'toBlock', 'toDate'],

diff --git a/packages/common/evmUtils/src/operations/utils/runContractFunctionOperation.test.ts b/packages/common/evmUtils/src/operations/utils/runContractFunctionOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { EvmAddress, EvmChain } from '../../dataTypes';
 import { runContractFunctionOperation, RunContractFunctionRequest } from './runContractFunctionOperation';
 

diff --git a/packages/common/evmUtils/src/operations/utils/runContractFunctionOperation.ts b/packages/common/evmUtils/src/operations/utils/runContractFunctionOperation.ts
@@ -3,12 +3,12 @@ import { EvmAddress, EvmAddressish, EvmChain, EvmChainish } from '../../dataType
 import { EvmChainResolver } from '../../EvmChainResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'runContractFunction';
-type PathParams = operations[OperationName]['parameters']['path'];
-type QueryParams = operations[OperationName]['parameters']['query'];
-type BodyParams = operations[OperationName]['requestBody']['content']['application/json'];
+type OperationId = 'runContractFunction';
+type PathParams = operations[OperationId]['parameters']['path'];
+type QueryParams = operations[OperationId]['parameters']['query'];
+type BodyParams = operations[OperationId]['requestBody']['content']['application/json'];
 type RequestParams = PathParams & QueryParams & BodyParams;
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -32,6 +32,7 @@ export const runContractFunctionOperation: Operation<
 > = {
   method: 'POST',
   name: 'runContractFunction',
+  id: 'runContractFunction',
   groupName: 'token',
   urlPathParamNames: ['address'],
   urlSearchParamNames: ['chain', 'functionName', 'providerUrl', 'subdomain'],

diff --git a/packages/common/solUtils/src/operations/account/getBalanceOperation.test.ts b/packages/common/solUtils/src/operations/account/getBalanceOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getBalanceOperation, GetBalanceRequest } from './getBalanceOperation';
 

diff --git a/packages/common/solUtils/src/operations/account/getBalanceOperation.ts b/packages/common/solUtils/src/operations/account/getBalanceOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNative, SolNetwork, SolNetworkish } from
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'balance';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'balance';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -27,7 +27,8 @@ export const getBalanceOperation: Operation<
   GetBalanceJSONResponse
 > = {
   method: 'GET',
-  name: 'balance',
+  name: 'getBalance',
+  id: 'balance',
   groupName: 'account',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/account/{network}/{address}/balance',

diff --git a/packages/common/solUtils/src/operations/account/getNFTsOperation.test.ts b/packages/common/solUtils/src/operations/account/getNFTsOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getNFTsOperation, GetNFTsRequest } from './getNFTsOperation';
 

diff --git a/packages/common/solUtils/src/operations/account/getNFTsOperation.ts b/packages/common/solUtils/src/operations/account/getNFTsOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNetwork, SolNetworkish } from '../../data
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getNFTs';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getNFTs';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -23,6 +23,7 @@ export type GetNFTsResponse = ReturnType<typeof deserializeResponse>;
 export const getNFTsOperation: Operation<GetNFTsRequest, GetNFTsJSONRequest, GetNFTsResponse, GetNFTsJSONResponse> = {
   method: 'GET',
   name: 'getNFTs',
+  id: 'getNFTs',
   groupName: 'account',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/account/{network}/{address}/nft',

diff --git a/packages/common/solUtils/src/operations/account/getPortfolioOperation.test.ts b/packages/common/solUtils/src/operations/account/getPortfolioOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getPortfolioOperation, GetPortfolioRequest } from './getPortfolioOperation';
 

diff --git a/packages/common/solUtils/src/operations/account/getPortfolioOperation.ts b/packages/common/solUtils/src/operations/account/getPortfolioOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNative, SolNetwork, SolNetworkish } from
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getPortfolio';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getPortfolio';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -28,6 +28,7 @@ export const getPortfolioOperation: Operation<
 > = {
   method: 'GET',
   name: 'getPortfolio',
+  id: 'getPortfolio',
   groupName: 'account',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/account/{network}/{address}/portfolio',

diff --git a/packages/common/solUtils/src/operations/account/getSPLOperation.test.ts b/packages/common/solUtils/src/operations/account/getSPLOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getSPLOperation, GetSPLRequest } from './getSPLOperation';
 

diff --git a/packages/common/solUtils/src/operations/account/getSPLOperation.ts b/packages/common/solUtils/src/operations/account/getSPLOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNative, SolNetwork, SolNetworkish } from
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getSPL';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getSPL';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -23,6 +23,7 @@ export type GetSPLResponse = ReturnType<typeof deserializeResponse>;
 export const getSPLOperation: Operation<GetSPLRequest, GetSPLJSONRequest, GetSPLResponse, GetSPLJSONResponse> = {
   method: 'GET',
   name: 'getSPL',
+  id: 'getSPL',
   groupName: 'account',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/account/{network}/{address}/tokens',

diff --git a/packages/common/solUtils/src/operations/nft/getNFTMetadataOperation.test.ts b/packages/common/solUtils/src/operations/nft/getNFTMetadataOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getNFTMetadataOperation, GetNFTMetadataRequest } from './getNFTMetadataOperation';
 

diff --git a/packages/common/solUtils/src/operations/nft/getNFTMetadataOperation.ts b/packages/common/solUtils/src/operations/nft/getNFTMetadataOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNetwork, SolNetworkish } from '../../data
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getNFTMetadata';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getNFTMetadata';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -28,6 +28,7 @@ export const getNFTMetadataOperation: Operation<
 > = {
   method: 'GET',
   name: 'getNFTMetadata',
+  id: 'getNFTMetadata',
   groupName: 'nft',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/nft/{network}/{address}/metadata',

diff --git a/packages/common/solUtils/src/operations/operations.test.ts b/packages/common/solUtils/src/operations/operations.test.ts
@@ -10,9 +10,9 @@ describe('operations', () => {
 
   for (const operation of operations) {
     it(`${operation.name} defines all supported parameters`, () => {
-      const openApiPathParamNames = reader.readOperationPathParamNames(operation.name);
-      const openApiSearchParamNames = reader.readOperationSearchParamNames(operation.name);
-      const openApiBodyParamNames = reader.readOperationRequestBodyParamNames(operation.name);
+      const openApiPathParamNames = reader.readOperationPathParamNames(operation.id);
+      const openApiSearchParamNames = reader.readOperationSearchParamNames(operation.id);
+      const openApiBodyParamNames = reader.readOperationRequestBodyParamNames(operation.id);
 
       expect(operation.urlPathParamNames.sort().join(',')).toBe(openApiPathParamNames?.sort().join(','));
       expect(operation.urlSearchParamNames?.sort().join(',')).toBe(openApiSearchParamNames?.sort().join(','));

diff --git a/packages/common/solUtils/src/operations/token/getTokenPriceOperation.test.ts b/packages/common/solUtils/src/operations/token/getTokenPriceOperation.test.ts
@@ -1,4 +1,4 @@
-import MoralisCore from '@moralisweb3/core';
+import MoralisCore from '@moralisweb3/common-core';
 import { SolAddress, SolNetwork } from '../../dataTypes';
 import { getTokenPriceOperation, GetTokenPriceRequest } from './getTokenPriceOperation';
 

diff --git a/packages/common/solUtils/src/operations/token/getTokenPriceOperation.ts b/packages/common/solUtils/src/operations/token/getTokenPriceOperation.ts
@@ -3,9 +3,9 @@ import { SolAddress, SolAddressish, SolNative, SolNetwork, SolNetworkish } from
 import { SolNetworkResolver } from '../../SolNetworkResolver';
 import { operations } from '../openapi';
 
-type OperationName = 'getTokenPrice';
-type PathParams = operations[OperationName]['parameters']['path'];
-type SuccessResponse = operations[OperationName]['responses']['200']['content']['application/json'];
+type OperationId = 'getTokenPrice';
+type PathParams = operations[OperationId]['parameters']['path'];
+type SuccessResponse = operations[OperationId]['responses']['200']['content']['application/json'];
 
 // Exports
 
@@ -28,6 +28,7 @@ export const getTokenPriceOperation: Operation<
 > = {
   method: 'GET',
   name: 'getTokenPrice',
+  id: 'getTokenPrice',
   groupName: 'token',
   urlPathParamNames: ['network', 'address'],
   urlPathPattern: '/token/{network}/{address}/price',
Title	Statements	Branches	Functions
api-utils	60.45% (295/488)	44.62% (54/121)	64.48% (69/107)
auth	100% (143/143)	90.9% (20/22)	100% (42/42)
evm-api	81.46% (466/572)	16.56% (54/326)	64.3% (191/297)
common-evm-utils	63.61% (675/1061)	35.35% (105/297)	31.79% (117/368)
sol-api	100% (20/20)	66.66% (4/6)	100% (6/6)
common-sol-utils	74.86% (134/179)	63.15% (12/19)	65.67% (44/67)
common-streams-utils	95.6% (674/705)	97.93% (190/194)	100% (244/244)
streams	82.72% (388/469)	64% (64/100)	73.6% (92/125)