Skip to content

Commit

Permalink
refactor: rename MoralisCore to Core
Browse files Browse the repository at this point in the history
  • Loading branch information
ErnoW committed Oct 26, 2022
1 parent ec11ee9 commit 6757267
Show file tree
Hide file tree
Showing 111 changed files with 399 additions and 441 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,10 +124,10 @@ yarn add @moralisweb3/common-core @moralisweb3/evm @moralisweb3/evm-api @moralis
Then at the top of your code (before any interaction with Moralis), you need to register the modules to the core package

```javascript
import MoralisCore from '@moralisweb3/common-core';
import Core from '@moralisweb3/common-core';
import MoralisEvmApi from '@moralisweb3/evm-api';

const core = MoralisCore.create();
const core = Core.create();
// Register all imported modules to the @moralisweb3/common-core module
core.registerModules([MoralisEvmApi]);
```
Expand Down Expand Up @@ -162,10 +162,10 @@ Of course you are free to combine the modules in a single object, and use that i

```javascript
// moralis.ts
import { MoralisCore } from '@moralisweb3/common-core';
import { Core } from '@moralisweb3/common-core';
import EvmApi from '@moralisweb3/evm-api';

const core = MoralisCore.create();
const core = Core.create();
const evmApi = EvmApi.create(core);
core.registerModules([evmApi]);

Expand Down
4 changes: 2 additions & 2 deletions demos/parse-server/src/utils/ParseServerRequest.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { MoralisCoreProvider, RequestController } from '@moralisweb3/common-core';
import { CoreProvider, RequestController } from '@moralisweb3/common-core';
import config from '../config';

export class ParseServerRequest {
protected readonly requestController: RequestController;

constructor() {
const core = MoralisCoreProvider.getDefault();
const core = CoreProvider.getDefault();
this.requestController = RequestController.create(core);
}

Expand Down
8 changes: 4 additions & 4 deletions packages/apiUtils/src/ApiUtils.ts
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
import { Module, MoralisCore, MoralisCoreProvider } from '@moralisweb3/common-core';
import { Module, Core, CoreProvider } from '@moralisweb3/common-core';
import { ApiUtilsConfigSetup } from './config/ApiUtilsConfigSetup';

export class ApiUtils extends Module {
public static readonly moduleName = 'api';

public static create(core?: MoralisCore): ApiUtils {
return new ApiUtils(core ?? MoralisCoreProvider.getDefault());
public static create(core?: Core): ApiUtils {
return new ApiUtils(core ?? CoreProvider.getDefault());
}

public constructor(core: MoralisCore) {
public constructor(core: Core) {
super(ApiUtils.moduleName, core);
}

Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers/Endpoint.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { MoralisCore } from '@moralisweb3/common-core';
import { Core } from '@moralisweb3/common-core';

export type EndpointMethod = 'get' | 'post' | 'put' | 'delete';

Expand All @@ -21,7 +21,7 @@ export interface Endpoint<ApiParams, Params, ApiResult, AdaptedResult, JSONResul
}

export type EndpointFactory<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> = (
core: MoralisCore,
core: Core,
) => Endpoint<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>;

export function createEndpointFactory<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>(
Expand Down
6 changes: 3 additions & 3 deletions packages/apiUtils/src/resolvers/EndpointResolver.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import { ApiFormatType } from './ApiResultAdapter';
import axios from 'axios';
import { EndpointResolver } from './EndpointResolver';
import { setupApi } from '../test/setup';
import { MoralisCore } from '@moralisweb3/common-core';
import { Core } from '@moralisweb3/common-core';
import { createEndpoint, createEndpointFactory } from './Endpoint';

const MOCK_API_KEY = 'test-api-key';
Expand All @@ -25,7 +25,7 @@ interface EndpointWeight {
}

describe('ApiResolver', () => {
let core: MoralisCore;
let core: Core;
let resolver: EndpointResolver<
unknown,
unknown,
Expand Down Expand Up @@ -97,7 +97,7 @@ describe('ApiResolver', () => {
'x-api-key': MOCK_API_KEY,
'x-moralis-build-target': expect.any(String),
'x-moralis-platform': expect.any(String),
'x-moralis-platform-version': MoralisCore.libVersion,
'x-moralis-platform-version': Core.libVersion,
}),
}),
);
Expand Down
11 changes: 2 additions & 9 deletions packages/apiUtils/src/resolvers/EndpointResolver.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
import {
MoralisCore,
ApiErrorCode,
Config,
MoralisApiError,
RequestController,
CoreConfig,
} from '@moralisweb3/common-core';
import { Core, ApiErrorCode, Config, MoralisApiError, RequestController, CoreConfig } from '@moralisweb3/common-core';
import { ApiUtilsConfig } from '../config/ApiUtilsConfig';
import { isNotFoundError } from '../errors/isNotFoundError';
import { ApiResultAdapter } from './ApiResultAdapter';
Expand All @@ -15,7 +8,7 @@ import { getCommonHeaders } from './getCommonHeaders';

export class EndpointResolver<ApiParams, Params, ApiResult, AdaptedResult, JSONResult> {
public static create<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>(
core: MoralisCore,
core: Core,
baseUrl: string,
endpointFactory: EndpointFactory<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>,
) {
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers/Endpoints.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore from '@moralisweb3/common-core';
import Core from '@moralisweb3/common-core';
import { Endpoint, EndpointFactory, EndpointMethod } from './Endpoint';
import { EndpointResolver } from './EndpointResolver';
import { PaginatedEndpointFactory, PaginatedParams } from './PaginatedEndpoint';
Expand All @@ -18,7 +18,7 @@ export class Endpoints {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
private readonly endpoints: Endpoint<any, any, any, any, unknown>[] = [];

public constructor(private readonly core: MoralisCore, private readonly baseUrl: string) {}
public constructor(private readonly core: Core, private readonly baseUrl: string) {}

public createFetcher<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>(
factory: EndpointFactory<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>,
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers/PaginatedEndpoint.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore from '@moralisweb3/common-core';
import Core from '@moralisweb3/common-core';
import { Endpoint, EndpointBodyType } from './Endpoint';

export interface PaginatedParams extends Record<string, unknown> {
Expand All @@ -24,7 +24,7 @@ export type PaginatedEndpointFactory<
ApiResult,
AdaptedResult,
JSONResult,
> = (core: MoralisCore) => PaginatedEndpoint<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>;
> = (core: Core) => PaginatedEndpoint<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>;

export function createPaginatedEndpointFactory<
ApiParams,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from './PaginatedEndpoint';
import { setupApi } from '../test/setup';
import { PaginatedEndpointResolver } from './PaginatedEndpointResolver';
import { MoralisCore } from '@moralisweb3/common-core';
import { Core } from '@moralisweb3/common-core';

const MOCK_API_KEY = 'test-api-key';
const API_ROOT = 'https://deep-index.moralis.io/api/v2';
Expand Down Expand Up @@ -60,7 +60,7 @@ type ApiResult = {
}[];

describe('PaginatedEndpointResolver', () => {
let core: MoralisCore;
let core: Core;
let resolver: PaginatedEndpointResolver<
any,
Params,
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers/PaginatedEndpointResolver.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { tryGetNextPageParams } from '../utils/tryGetNextPageParams';
import { ApiPaginatedResultAdapter } from './ApiPaginatedResultAdapter';
import { ApiUtilsConfig } from '../config/ApiUtilsConfig';
import { MoralisCore, ApiErrorCode, Config, MoralisApiError, RequestController } from '@moralisweb3/common-core';
import { Core, ApiErrorCode, Config, MoralisApiError, RequestController } from '@moralisweb3/common-core';
import { PaginatedResult, PaginatedEndpoint, PaginatedEndpointFactory, PaginatedParams } from './PaginatedEndpoint';
import { EndpointParamsReader } from './EndpointParamsReader';

Expand All @@ -13,7 +13,7 @@ export class PaginatedEndpointResolver<
JSONResult,
> {
public static create<ApiParams, Params extends PaginatedParams, ApiResult, AdaptedResult, JSONResult>(
core: MoralisCore,
core: Core,
baseUrl: string,
endpointFactory: PaginatedEndpointFactory<ApiParams, Params, ApiResult, AdaptedResult, JSONResult>,
) {
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers/getCommonHeaders.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import MoralisCore from '@moralisweb3/common-core';
import Core from '@moralisweb3/common-core';

export type Headers = { [key: string]: string };

export const getCommonHeaders = (): Headers => ({
'x-moralis-platform': 'JS SDK',
'x-moralis-platform-version': MoralisCore.libVersion,
'x-moralis-platform-version': Core.libVersion,
'x-moralis-build-target': 'node',
});
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore, { Operation, OperationRequestPropertiesBody } from '@moralisweb3/common-core';
import Core, { Operation, OperationRequestPropertiesBody } from '@moralisweb3/common-core';
import { ApiUtilsConfig } from '../config';
import { OperationRequestBuilder } from './OperationRequestBuilder';

Expand Down Expand Up @@ -44,11 +44,11 @@ const operation: Operation<TestRequest, unknown, unknown, unknown> = {
describe('OperationRequestBuilder', () => {
const API_KEY = '0000000000000000000000000000000000000000000000000000000000000123';

let core: MoralisCore;
let core: Core;
let builder: OperationRequestBuilder<TestRequest>;

beforeEach(() => {
core = MoralisCore.create();
core = Core.create();
core.config.registerKey(ApiUtilsConfig.apiKey);
core.config.set(ApiUtilsConfig.apiKey, API_KEY);
builder = new OperationRequestBuilder<TestRequest>(operation, core);
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers2/OperationRequestBuilder.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore, {
import Core, {
ApiErrorCode,
MoralisApiError,
Operation,
Expand All @@ -12,7 +12,7 @@ import { getCommonHeaders } from '../resolvers/getCommonHeaders';
export class OperationRequestBuilder<Request> {
public constructor(
private readonly operation: Operation<Request, unknown, unknown, unknown>,
private readonly core: MoralisCore,
private readonly core: Core,
) {}

public prepareUrl(request: Request) {
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/resolvers2/OperationResolver.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore, {
import Core, {
ApiErrorCode,
MoralisApiError,
RequestController,
Expand All @@ -18,7 +18,7 @@ export class OperationResolver<Request, JSONRequest, Response, JSONResponse> {
public constructor(
private readonly operation: Operation<Request, JSONRequest, Response, JSONResponse>,
private readonly baseUrl: string,
private readonly core: MoralisCore,
private readonly core: Core,
) {}

public readonly fetch = async (request: Request): Promise<ResponseAdapter<Response, JSONResponse>> => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import MoralisCore, {
import Core, {
PaginatedRequest,
OperationRequestValidator,
RequestController,
Expand All @@ -17,7 +17,7 @@ export class PaginatedOperationResolver<Request extends PaginatedRequest, JSONRe
public constructor(
private readonly operation: PaginatedOperation<Request, JSONRequest, Result, JSONResult>,
private readonly baseUrl: string,
private readonly core: MoralisCore,
private readonly core: Core,
) {}

public readonly fetch = async (request: Request): Promise<PaginatedResponseAdapter<Result, JSONResult>> => {
Expand Down
4 changes: 2 additions & 2 deletions packages/apiUtils/src/test/setup.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { MoralisCore } from '@moralisweb3/common-core';
import { Core } from '@moralisweb3/common-core';
import { CommonEvmUtils } from '@moralisweb3/common-evm-utils';
import { ApiUtils } from '../ApiUtils';

export const setupApi = () => {
const core = MoralisCore.create();
const core = Core.create();
const apiUtils = ApiUtils.create(core);
const evmUtils = CommonEvmUtils.create(core);

Expand Down
6 changes: 3 additions & 3 deletions packages/auth/integration/setup.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import { ApiUtils } from '@moralisweb3/api-utils';
import { CommonEvmUtils } from '@moralisweb3/common-evm-utils';
import { CommonSolUtils } from '@moralisweb3/common-sol-utils';
import { MoralisCore, MoralisCoreProvider } from '@moralisweb3/common-core';
import { Core, CoreProvider } from '@moralisweb3/common-core';
import { MoralisAuth } from '../src/MoralisAuth';
import { MOCK_API_KEY } from './mocks/config';
import { mockServer } from './mocks/mockServer';

export function setupAuth(): MoralisAuth {
const core = MoralisCore.create();
const core = Core.create();
const apiUtils = ApiUtils.create(core);
const commonEvmUtils = CommonEvmUtils.create(core);
const commonSolUtils = CommonSolUtils.create(core);
const auth = MoralisAuth.create(core);

MoralisCoreProvider.setDefault(core);
CoreProvider.setDefault(core);

core.registerModules([apiUtils, commonEvmUtils, commonSolUtils, auth]);
core.start({
Expand Down
8 changes: 4 additions & 4 deletions packages/auth/src/MoralisAuth.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { ApiModule, MoralisCore, MoralisCoreProvider } from '@moralisweb3/common-core';
import { ApiModule, Core, CoreProvider } from '@moralisweb3/common-core';
import { makeRequestMessage, RequestMessageOptions } from './methods/requestMessage';
import {
makeVerify,
Expand All @@ -14,11 +14,11 @@ export const BASE_URL = 'https://authapi.moralis.io';
export class MoralisAuth extends ApiModule {
public static readonly moduleName = 'auth';

public static create(core?: MoralisCore): MoralisAuth {
return new MoralisAuth(core ?? MoralisCoreProvider.getDefault());
public static create(core?: Core): MoralisAuth {
return new MoralisAuth(core ?? CoreProvider.getDefault());
}

private constructor(core: MoralisCore) {
private constructor(core: Core) {
super(MoralisAuth.moduleName, core, BASE_URL);
}

Expand Down
8 changes: 4 additions & 4 deletions packages/auth/src/methods/requestMessage.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { SolAddressish, SolNetworkish, SolAddress, SolNetwork } from '@moralisweb3/common-sol-utils';
import { EndpointResolver } from '@moralisweb3/api-utils';
import MoralisCore, { AuthErrorCode, MoralisAuthError } from '@moralisweb3/common-core';
import Core, { AuthErrorCode, MoralisAuthError } from '@moralisweb3/common-core';
import { EvmAddress, EvmAddressish, EvmChain, EvmChainish } from '@moralisweb3/common-evm-utils';
import { BASE_URL } from '../MoralisAuth';
import { initializeChallengeEvm, initializeChallengeSol } from '../resolvers';
Expand Down Expand Up @@ -48,7 +48,7 @@ export interface RequestMessageSolOptions {
export type RequestMessageOptions = RequestMessageEvmOptions | RequestMessageSolOptions;

const makeEvmRequestMessage = (
core: MoralisCore,
core: Core,
{ chain, address, networkType, network, ...options }: RequestMessageEvmOptions,
) => {
return EndpointResolver.create(core, BASE_URL, initializeChallengeEvm).fetch({
Expand All @@ -59,7 +59,7 @@ const makeEvmRequestMessage = (
};

const makeSolRequestMessage = (
core: MoralisCore,
core: Core,
{ address, solNetwork, networkType, network, ...options }: RequestMessageSolOptions,
) => {
return EndpointResolver.create(core, BASE_URL, initializeChallengeSol).fetch({
Expand All @@ -69,7 +69,7 @@ const makeSolRequestMessage = (
});
};

export const makeRequestMessage = (core: MoralisCore) => async (options: RequestMessageOptions) => {
export const makeRequestMessage = (core: Core) => async (options: RequestMessageOptions) => {
// Backwards compatibility for the 'network' parameter
if (!options.networkType && options.network) {
options.networkType = options.network;
Expand Down
8 changes: 4 additions & 4 deletions packages/auth/src/methods/verify.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { EndpointResolver } from '@moralisweb3/api-utils';
import MoralisCore, { AuthErrorCode, MoralisAuthError } from '@moralisweb3/common-core';
import Core, { AuthErrorCode, MoralisAuthError } from '@moralisweb3/common-core';
import { BASE_URL } from '../MoralisAuth';
import { completeChallengeEvm, completeChallengeSol } from '../resolvers';
import { AuthNetworkType } from '../utils/AuthNetworkType';
Expand Down Expand Up @@ -29,21 +29,21 @@ export type VerifyOptions = VerifyEvmOptions | VerifySolOptions;
export type VerifyEvmData = ReturnType<typeof makeEvmVerify>;
export type VerifySolData = ReturnType<typeof makeSolVerify>;

const makeEvmVerify = (core: MoralisCore, { networkType, network, ...options }: VerifyEvmOptions) => {
const makeEvmVerify = (core: Core, { networkType, network, ...options }: VerifyEvmOptions) => {
return EndpointResolver.create(core, BASE_URL, completeChallengeEvm).fetch({
message: options.message,
signature: options.signature,
});
};

const makeSolVerify = (core: MoralisCore, { networkType, network, ...options }: VerifySolOptions) => {
const makeSolVerify = (core: Core, { networkType, network, ...options }: VerifySolOptions) => {
return EndpointResolver.create(core, BASE_URL, completeChallengeSol).fetch({
message: options.message,
signature: options.signature,
});
};

export const makeVerify = (core: MoralisCore) => async (options: VerifyOptions) => {
export const makeVerify = (core: Core) => async (options: VerifyOptions) => {
// Backwards compatibility for the 'network' parameter
if (!options.networkType && options.network) {
options.networkType = options.network;
Expand Down
2 changes: 1 addition & 1 deletion packages/common/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Accepts the same options as `get()`, with the addition of `body`, which is an (J

Errors within Moralis are an instance of `MoralisError`. These are extended into a few different classes:

- `MoralisCoreError`
- `CoreError`
- `MoralisApiError`

Which are used in there respective packages. Creating a new error must accept the following 2 params:
Expand Down
Loading

0 comments on commit 6757267

Please sign in to comment.