Merge pull request #511 from MoralisWeb3/feat/apiutils

feat(apiUtils): apiUtil package without test

.changeset/forty-yaks-tie.md

@@ -0,0 +1,6 @@
+---
+'@moralisweb3/core': major
+'@moralisweb3/evm-api': major
+---
+
+Refactor evmApi package to use apiUtils

.changeset/old-cherries-jam.md

@@ -0,0 +1,5 @@
+---
+'@moralisweb3/api': major
+---
+
+Generic logic for api modules

.changeset/short-baboons-study.md

@@ -0,0 +1,5 @@
+---
+'@moralisweb3/api': major
+---
+
+rename package from apiUtils to api

packages/api/.prettierignore

@@ -0,0 +1,8 @@
+CHANGELOG.md
+
+# Output folders
+lib/**/*
+dist
+coverage/
+lib.esm
+node_modules

packages/api/.prettierrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../.prettierrc'),
+};

packages/api/README.md

@@ -0,0 +1 @@
+# @moralisweb3/api

packages/api/jest.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../jest.config'),
+};

packages/api/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@moralisweb3/api",
+  "author": "Moralis",
+  "version": "2.0.0-alpha.2",
+  "license": "MIT",
+  "private": false,
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "lib/index.*",
+    "lib/**/*.d.ts",
+    "dist"
+  ],
+  "scripts": {
+    "format": "prettier . \"**/*.+(js|ts|json)\" --write",
+    "lint": "eslint . --ext .js,.ts,.tsx,jsx",
+    "format:check": "prettier . \"**/*.+(js|ts|json)\" --check",
+    "clean": "rm -rf lib && rm -rf lib.esm && rm -rf tsconfig.tsbuildinfo",
+    "build": "tsc",
+    "dev": "tsc --watch"
+  },
+  "devDependencies": {
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.5"
+  },
+  "dependencies": {
+    "@moralisweb3/core": "^2.0.0-alpha.2"
+  }
+}

packages/api/rollup.config.js

@@ -0,0 +1,4 @@
+import packageJson from './package.json';
+import { commonJs, esm } from '../../rollup.config';
+
+export default [commonJs(packageJson), esm(packageJson)];

packages/evmApi/src/EvmApiPaginatedResultAdapter.ts → packages/api/src/ApiPaginatedResultAdapter.ts

@@ -1,21 +1,21 @@
 import { ApiErrorCode, MoralisApiError } from '@moralisweb3/core';
-import { EvmApiResultAdapter } from './EvmApiResultAdapter';
-import { PaginatedResponse } from './resolvers/PaginatedResolver';
+import { ApiResultAdapter } from './ApiResultAdapter';
+import { ApiPaginatedResponse } from './PaginatedResolver';
 
-export class EvmApiPaginatedResultAdapter<
-  Data extends PaginatedResponse<unknown>,
+export class ApiPaginatedResultAdapter<
+  Data extends ApiPaginatedResponse<unknown>,
   AdaptedData,
   JSONData,
   Params,
-> extends EvmApiResultAdapter<Data, AdaptedData, JSONData, Params> {
-  private _nextCall?: () => Promise<EvmApiPaginatedResultAdapter<Data, AdaptedData, JSONData, Params>>;
+> extends ApiResultAdapter<Data, AdaptedData, JSONData, Params> {
+  private _nextCall?: () => Promise<ApiPaginatedResultAdapter<Data, AdaptedData, JSONData, Params>>;
 
   constructor(
     data: Data,
     adapter: (data: Data, params: Params) => AdaptedData,
     jsonAdapter: (data: AdaptedData) => JSONData,
     params: Params,
-    nextCall?: () => Promise<EvmApiPaginatedResultAdapter<Data, AdaptedData, JSONData, Params>>,
+    nextCall?: () => Promise<ApiPaginatedResultAdapter<Data, AdaptedData, JSONData, Params>>,
   ) {
     super(data, adapter, jsonAdapter, params);
     this._nextCall = nextCall;

packages/evmApi/src/EvmApiResultAdapter.ts → packages/api/src/ApiResultAdapter.ts

@@ -2,7 +2,7 @@ import { ApiErrorCode, EvmAddress, EvmChain, MoralisApiError } from '@moralisweb
 import { MoralisDataObject } from '@moralisweb3/core';
 
 // TODO: make part of core config? The challenge in that case is to make sure it is Typed correctly
-enum EvmApiFormatType {
+enum ApiFormatType {
   // Return the data directly, as is provided by the API
   RAW = 'raw',
   // Return the formatted result of all moralis DataTypes
@@ -37,7 +37,7 @@ export type JSONApiResult<Value extends object = object> =
     }
   | JSONApiResult[];
 
-export class EvmApiResultAdapter<Data, AdaptedData, JSONData, Params> {
+export class ApiResultAdapter<Data, AdaptedData, JSONData, Params> {
   protected _data: Data;
   protected _adapter: (data: Data, params: Params) => AdaptedData;
   protected _jsonAdapter: (data: AdaptedData) => JSONData;
@@ -68,20 +68,20 @@ export class EvmApiResultAdapter<Data, AdaptedData, JSONData, Params> {
     return this._jsonAdapter(this.result);
   }
 
-  format(formatType: EvmApiFormatType.RAW): Data;
+  format(formatType: ApiFormatType.RAW): Data;
   // WIP: add type
-  format(formatType: EvmApiFormatType.JSON): unknown;
-  format(formatType: EvmApiFormatType.NORMAL): AdaptedData;
-  format(formatType: EvmApiFormatType) {
-    if (formatType === EvmApiFormatType.RAW) {
+  format(formatType: ApiFormatType.JSON): unknown;
+  format(formatType: ApiFormatType.NORMAL): AdaptedData;
+  format(formatType: ApiFormatType) {
+    if (formatType === ApiFormatType.RAW) {
       return this.raw;
     }
 
-    if (formatType === EvmApiFormatType.JSON) {
+    if (formatType === ApiFormatType.JSON) {
       return this.toJSON();
     }
 
-    if (formatType === EvmApiFormatType.NORMAL) {
+    if (formatType === ApiFormatType.NORMAL) {
       return this.result;
     }
 

packages/api/src/MoralisApi.ts

@@ -0,0 +1,16 @@
+import { ApiModule, MoralisCore } from '@moralisweb3/core';
+import { ApiConfigSetup } from './config/ApiConfigSetup';
+
+export class MoralisApi extends ApiModule {
+  public constructor(moduleName: string, core: MoralisCore, baseUrl: string) {
+    super(moduleName, core, baseUrl);
+  }
+
+  public setup() {
+    ApiConfigSetup.register(this.core.config);
+  }
+
+  public start(): void | Promise<void> {
+    // Nothing...
+  }
+}

packages/evmApi/src/resolvers/PaginatedResolver.ts → packages/api/src/PaginatedResolver.ts

@@ -1,42 +1,42 @@
-import { checkObjEqual } from './../utils/checkObjEqual';
-import { EvmResolver, EvmResolverOptions } from './Resolver';
-import { getNextParams } from '../utils/getNextParams';
-import { EvmApiPaginatedResultAdapter } from '../EvmApiPaginatedResultAdapter';
-import { EvmApiConfig } from '../config/EvmApiConfig';
-import { ApiErrorCode, MoralisApiError } from '@moralisweb3/core/lib';
-
-export interface PaginatedResponse<Data> {
+import { checkObjEqual } from './utils/checkObjEqual';
+import { ApiResolver, ApiResolverOptions } from './Resolver';
+import { getNextParams } from './utils/getNextParams';
+import { ApiPaginatedResultAdapter } from './ApiPaginatedResultAdapter';
+import { ApiConfig } from './config/ApiConfig';
+import { ApiErrorCode, MoralisApiError } from '@moralisweb3/core';
+
+export interface ApiPaginatedResponse<Data> {
   total: number;
   page: number;
   page_size: number;
   cursor: string;
   result: Data;
 }
 
-export interface PaginatedOptions extends Record<string, unknown> {
+export interface ApiPaginatedOptions extends Record<string, unknown> {
   offset?: number;
   limit?: number;
   cursor?: string;
 }
 
-export class EvmPaginatedResolver<
+export class ApiPaginatedResolver<
   ApiParams,
-  Params extends PaginatedOptions,
+  Params extends ApiPaginatedOptions,
   ApiResult,
   AdaptedResult,
   JSONResult,
-> extends EvmResolver<ApiParams, Params, PaginatedResponse<ApiResult>, AdaptedResult, JSONResult> {
+> extends ApiResolver<ApiParams, Params, ApiPaginatedResponse<ApiResult>, AdaptedResult, JSONResult> {
   constructor({
-    getPath,
+    getUrl,
     apiToResult,
     resultToJson,
     parseParams,
     method,
     bodyParams,
     bodyType,
     name,
-  }: EvmResolverOptions<ApiParams, Params, PaginatedResponse<ApiResult>, AdaptedResult, JSONResult>) {
-    super({ getPath, apiToResult, resultToJson, parseParams, method, bodyParams, bodyType, name });
+  }: ApiResolverOptions<ApiParams, Params, ApiPaginatedResponse<ApiResult>, AdaptedResult, JSONResult>) {
+    super({ getUrl, apiToResult, resultToJson, parseParams, method, bodyParams, bodyType, name });
   }
 
   // TODO: error handler to ApiError
@@ -50,11 +50,11 @@ export class EvmPaginatedResolver<
     // @ts-ignore TODO: fix the ApiParams type, as it should extend Searchparams
     const result = await this.requestController.get<PaginatedResponse<ApiResult>, ApiParams>(url, searchParams, {
       headers: {
-        'x-api-key': this.config.get(EvmApiConfig.apiKey),
+        'x-api-key': this.config.get(ApiConfig.apiKey),
       },
     });
 
-    return new EvmApiPaginatedResultAdapter(
+    return new ApiPaginatedResultAdapter(
       result,
       this.apiToResult,
       this.resultToJson,
@@ -70,21 +70,21 @@ export class EvmPaginatedResolver<
     const searchParams = this.getSearchParams(apiParams);
     const bodyParams = this.getBodyParams(apiParams);
 
-    const apiKey = this.config.get(EvmApiConfig.apiKey);
+    const apiKey = this.config.get(ApiConfig.apiKey);
     const headers: { [key: string]: string } = {};
     if (apiKey) {
       headers['x-api-key'] = apiKey;
     }
 
     const result = await this.requestController.post<
-      PaginatedResponse<ApiResult>,
+      ApiPaginatedResponse<ApiResult>,
       Record<string, string>,
       Record<string, string>
     >(url, searchParams, bodyParams, {
       headers,
     });
 
-    return new EvmApiPaginatedResultAdapter(
+    return new ApiPaginatedResultAdapter(
       result,
       this.apiToResult,
       this.resultToJson,
@@ -93,17 +93,17 @@ export class EvmPaginatedResolver<
     );
   };
 
-  private resolveNextCall = (params: Params, result: Awaited<PaginatedResponse<ApiResult>>) => {
+  private resolveNextCall = (params: Params, result: Awaited<ApiPaginatedResponse<ApiResult>>) => {
     const nextParams = getNextParams(params, result);
     return checkObjEqual(params, nextParams) ? undefined : () => this.fetch(nextParams);
   };
 
   fetch = (
     params: Params,
   ): Promise<
-    EvmApiPaginatedResultAdapter<Awaited<PaginatedResponse<ApiResult>>, AdaptedResult, JSONResult, Params>
+    ApiPaginatedResultAdapter<Awaited<ApiPaginatedResponse<ApiResult>>, AdaptedResult, JSONResult, Params>
   > => {
-    const apiKey = this.config.get(EvmApiConfig.apiKey);
+    const apiKey = this.config.get(ApiConfig.apiKey);
 
     if (!apiKey) {
       throw new MoralisApiError({

packages/evmApi/src/resolvers/Resolver.ts → packages/api/src/Resolver.ts

@@ -1,15 +1,15 @@
 import { ApiErrorCode, Config, MoralisCoreProvider, MoralisApiError, RequestController } from '@moralisweb3/core';
-import { EvmApiConfig } from '../config/EvmApiConfig';
-import { BASE_URL } from '../EvmApi';
-import { EvmApiResultAdapter } from '../EvmApiResultAdapter';
+import { ApiConfig } from './config/ApiConfig';
+import { ApiResultAdapter } from './ApiResultAdapter';
 
 type Method = 'get' | 'post' | 'put';
 export enum BodyType {
   PROPERTY = 'property',
   BODY = 'body',
 }
-export interface EvmResolverOptions<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> {
-  getPath: (params: Params) => string;
+
+export interface ApiResolverOptions<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> {
+  getUrl: (params: Params) => string;
   apiToResult: (result: ApiResult, params: Params) => AdaptedResult;
   resultToJson: (result: AdaptedResult) => JSONResult;
   parseParams: (params: Params) => ApiParams;
@@ -19,8 +19,8 @@ export interface EvmResolverOptions<ApiParams, Params, ApiResult, AdaptedResult,
   name: string;
 }
 
-export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> {
-  protected getPath: (params: Params) => string;
+export class ApiResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> {
+  protected getUrl: (params: Params) => string;
   protected apiToResult: (result: ApiResult, params: Params) => AdaptedResult;
   protected resultToJson: (result: AdaptedResult) => JSONResult;
   protected parseParams: (params: Params) => ApiParams;
@@ -32,16 +32,16 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
   protected readonly requestController: RequestController;
 
   constructor({
-    getPath,
+    getUrl,
     apiToResult,
     resultToJson,
     parseParams,
     method,
     bodyParams,
     bodyType,
     name,
-  }: EvmResolverOptions<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>) {
-    this.getPath = getPath;
+  }: ApiResolverOptions<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>) {
+    this.getUrl = getUrl;
     this.apiToResult = apiToResult;
     this.resultToJson = resultToJson;
     this.parseParams = parseParams;
@@ -54,10 +54,6 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
     this.requestController = RequestController.create(core);
   }
 
-  protected getUrl = (params: Params) => {
-    return `${BASE_URL}/${this.getPath(params)}`;
-  };
-
   protected isBodyParam = (param: string) => {
     if (this.method === 'get') {
       return false;
@@ -109,7 +105,7 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
       headers: this.createHeaders(),
     });
 
-    return new EvmApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
+    return new ApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
   };
 
   protected _apiPost = async (params: Params) => {
@@ -128,7 +124,7 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
       },
     );
 
-    return new EvmApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
+    return new ApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
   };
 
   protected _apiPut = async (params: Params) => {
@@ -147,11 +143,11 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
       },
     );
 
-    return new EvmApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
+    return new ApiResultAdapter(result, this.apiToResult, this.resultToJson, params);
   };
 
   private createHeaders(): { [key: string]: string } {
-    const apiKey = this.config.get(EvmApiConfig.apiKey);
+    const apiKey = this.config.get(ApiConfig.apiKey);
     const headers: { [key: string]: string } = {};
     if (apiKey) {
       headers['x-api-key'] = apiKey;
@@ -160,7 +156,7 @@ export class EvmResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult
   }
 
   fetch = (params: Params) => {
-    const apiKey = this.config.get(EvmApiConfig.apiKey);
+    const apiKey = this.config.get(ApiConfig.apiKey);
 
     if (!apiKey) {
       throw new MoralisApiError({

packages/evmApi/src/config/EvmApiConfig.ts → packages/api/src/config/ApiConfig.ts

@@ -1,6 +1,6 @@
 import { ConfigKey } from '@moralisweb3/core';
 
-export const EvmApiConfig = {
+export const ApiConfig = {
   apiKey: {
     name: 'apiKey',
     defaultValue: null,