From 195d7226e865bc458eda992f62efc1b1e62c3f37 Mon Sep 17 00:00:00 2001 From: Jerko Steiner Date: Fri, 13 Sep 2019 23:49:05 +0700 Subject: [PATCH] Rename jsonrpc types --- packages/common/src/team/ITeamService.ts | 4 ++-- packages/common/src/user/IUserService.ts | 4 ++-- packages/jsonrpc/src/bulk.test.ts | 6 +++--- packages/jsonrpc/src/bulk.ts | 12 ++++++------ packages/jsonrpc/src/createClientMock.ts | 8 ++++---- packages/jsonrpc/src/express.test.ts | 4 ++-- packages/jsonrpc/src/local.test.ts | 4 ++-- packages/jsonrpc/src/local.ts | 6 +++--- packages/jsonrpc/src/redux.test.ts | 4 ++-- packages/jsonrpc/src/redux.ts | 18 +++++++++--------- packages/jsonrpc/src/remote.test.ts | 4 ++-- packages/jsonrpc/src/remote.ts | 4 ++-- packages/jsonrpc/src/supertest.ts | 4 ++-- packages/jsonrpc/src/types.ts | 12 ++++++------ packages/server/src/rpc/RPC.ts | 4 ++-- packages/server/src/test-utils/TestUtils.ts | 4 ++-- 16 files changed, 51 insertions(+), 51 deletions(-) diff --git a/packages/common/src/team/ITeamService.ts b/packages/common/src/team/ITeamService.ts index 4062d24..95bc332 100644 --- a/packages/common/src/team/ITeamService.ts +++ b/packages/common/src/team/ITeamService.ts @@ -1,4 +1,4 @@ -import { TReduxed } from '@rondo.dev/jsonrpc' +import { RPCActions } from '@rondo.dev/jsonrpc' import { keys } from 'ts-transformer-keys' import { Team } from '../entities' import { ITeamAddUserParams } from './ITeamAddUserParams' @@ -27,4 +27,4 @@ export interface ITeamService { } export const TeamServiceMethods = keys() -export type TeamActions = TReduxed +export type TeamActions = RPCActions diff --git a/packages/common/src/user/IUserService.ts b/packages/common/src/user/IUserService.ts index be4be8f..c7dc31d 100644 --- a/packages/common/src/user/IUserService.ts +++ b/packages/common/src/user/IUserService.ts @@ -1,4 +1,4 @@ -import { TReduxed } from '@rondo.dev/jsonrpc' +import { RPCActions } from '@rondo.dev/jsonrpc' import { keys } from 'ts-transformer-keys' import { IUser } from './IUser' @@ -9,4 +9,4 @@ export interface IUserService { } export const UserServiceMethods = keys() -export type UserActions = TReduxed +export type UserActions = RPCActions diff --git a/packages/jsonrpc/src/bulk.test.ts b/packages/jsonrpc/src/bulk.test.ts index ed8c7e2..81a8727 100644 --- a/packages/jsonrpc/src/bulk.test.ts +++ b/packages/jsonrpc/src/bulk.test.ts @@ -1,6 +1,6 @@ import * as util from './bulk' import express from 'express' -import {Contextual} from './types' +import {WithContext} from './types' import {jsonrpc} from './express' import {noopLogger} from './test-utils' import {createClient} from './supertest' @@ -21,13 +21,13 @@ describe('util', () => { userId: number } - class Service1 implements Contextual { + class Service1 implements WithContext { add(cx: IContext, a: number, b: number) { return a + b + cx.userId } } - class Service2 implements Contextual { + class Service2 implements WithContext { mul(cx: IContext, a: number, b: number) { return a * b + cx.userId } diff --git a/packages/jsonrpc/src/bulk.ts b/packages/jsonrpc/src/bulk.ts index 3643e89..389794d 100644 --- a/packages/jsonrpc/src/bulk.ts +++ b/packages/jsonrpc/src/bulk.ts @@ -1,5 +1,5 @@ import {IJSONRPCReturnType} from './express' -import {Contextual, TAsyncified, TReduxed} from './types' +import {WithContext, RPCClient, RPCActions} from './types' import {createActions} from './redux' import {createLocalClient, LocalClient} from './local' @@ -8,11 +8,11 @@ function keys(obj: T): Array { } export type BulkServices = { - [K in keyof T & string]: Contextual + [K in keyof T & string]: WithContext } export type BulkLocalClient = {[K in keyof T & string]: LocalClient} -export type BulkActions = {[K in keyof T & string]: TReduxed} -export type BulkClient = {[K in keyof T & string]: TAsyncified} +export type BulkActions = {[K in keyof T & string]: RPCActions} +export type BulkClient = {[K in keyof T & string]: RPCClient} function bulkCreate( src: T, @@ -25,14 +25,14 @@ function bulkCreate( }, {} as any) } -export function bulkCreateLocalClient>( +export function bulkCreateLocalClient>( src: T, context: Cx, ): BulkLocalClient { return bulkCreate(src, (key, value) => createLocalClient(value, context)) } -export function bulkCreateActions>>( +export function bulkCreateActions>>( src: T, ): BulkActions { return bulkCreate(src, (key, value) => createActions(value, key)) diff --git a/packages/jsonrpc/src/createClientMock.ts b/packages/jsonrpc/src/createClientMock.ts index 1e3be81..57d23a0 100644 --- a/packages/jsonrpc/src/createClientMock.ts +++ b/packages/jsonrpc/src/createClientMock.ts @@ -1,4 +1,4 @@ -import { FunctionPropertyNames, TAsyncified } from './types' +import { FunctionPropertyNames, RPCClient } from './types' export type TMocked = { [K in keyof T]: @@ -20,7 +20,7 @@ export type TMocked = { */ export default function createClientMock( methods: Array>, -): [TAsyncified, TMocked>] { +): [RPCClient, TMocked>] { const client = methods .reduce((obj, prop) => { obj[prop] = jest.fn() @@ -28,7 +28,7 @@ export default function createClientMock( }, {} as any) return [ - client as TAsyncified, - client as TMocked>, + client as RPCClient, + client as TMocked>, ] } diff --git a/packages/jsonrpc/src/express.test.ts b/packages/jsonrpc/src/express.test.ts index 9557a9a..7495ec2 100644 --- a/packages/jsonrpc/src/express.test.ts +++ b/packages/jsonrpc/src/express.test.ts @@ -6,7 +6,7 @@ import {createClient} from './supertest' import {ensure} from './ensure' import {jsonrpc} from './express' import {noopLogger} from './test-utils' -import {Contextual} from './types' +import {WithContext} from './types' describe('jsonrpc', () => { @@ -27,7 +27,7 @@ describe('jsonrpc', () => { const ensureLoggedIn = ensure(c => !!c.userId) - class Service implements Contextual { + class Service implements WithContext { constructor(readonly time: number) {} add(context: IContext, a: number, b: number) { return a + b diff --git a/packages/jsonrpc/src/local.test.ts b/packages/jsonrpc/src/local.test.ts index 35335c2..1b3262f 100644 --- a/packages/jsonrpc/src/local.test.ts +++ b/packages/jsonrpc/src/local.test.ts @@ -1,6 +1,6 @@ import {createLocalClient} from './local' import {keys} from 'ts-transformer-keys' -import {Contextual, ReverseContextual, TAsyncified} from './types' +import {WithContext, WithoutContext, RPCClient} from './types' describe('local', () => { @@ -14,7 +14,7 @@ describe('local', () => { userId: 1000 } - class Service implements Contextual { + class Service implements WithContext { add(cx: IContext, a: number, b: number) { return a + b } diff --git a/packages/jsonrpc/src/local.ts b/packages/jsonrpc/src/local.ts index 8272486..4f2775a 100644 --- a/packages/jsonrpc/src/local.ts +++ b/packages/jsonrpc/src/local.ts @@ -1,9 +1,9 @@ -import {TAsyncified, Contextual, ReverseContextual} from './types' +import {RPCClient, WithContext, WithoutContext} from './types' import {Request} from 'express' import {TGetContext} from './express' import {getAllMethods} from './jsonrpc' -export type LocalClient = TAsyncified> +export type LocalClient = RPCClient> /** * Creates a local client for a specific service instance. The actual service @@ -11,7 +11,7 @@ export type LocalClient = TAsyncified> * on the client- and server-side. * * The service argument is expected to be a class implementing the - * Contextual type. The first (context) argument will be + * WithContext type. The first (context) argument will be * automatically removed from all methods in the service, and the supplied * context argument will be used instead. */ diff --git a/packages/jsonrpc/src/redux.test.ts b/packages/jsonrpc/src/redux.test.ts index 1e956d8..679bd2a 100644 --- a/packages/jsonrpc/src/redux.test.ts +++ b/packages/jsonrpc/src/redux.test.ts @@ -6,7 +6,7 @@ import bodyParser from 'body-parser' import express from 'express' import {AddressInfo} from 'net' import {Server} from 'http' -import {Contextual, TPendingActions, TAllActions} from './types' +import {WithContext, TPendingActions, TAllActions} from './types' import {combineReducers} from 'redux' import {createActions, createReducer} from './redux' import {createRemoteClient} from './remote' @@ -30,7 +30,7 @@ describe('createActions', () => { userId: number } - class Service implements Contextual { + class Service implements WithContext { add(cx: IContext, a: number, b: number) { return a + b } diff --git a/packages/jsonrpc/src/redux.ts b/packages/jsonrpc/src/redux.ts index 4d0aedd..5a5a080 100644 --- a/packages/jsonrpc/src/redux.ts +++ b/packages/jsonrpc/src/redux.ts @@ -1,14 +1,14 @@ import { - IReduxed, - TAsyncified, - TReduxed, + IRPCActions, + RPCClient, + RPCActions, TResolvedActions, TAllActions, - TReduxHandlers, + RPCReduxHandlers, } from './types' export function createActions( - client: TAsyncified, + client: RPCClient, type: ActionType, ) { const service = Object.keys(client).reduce((obj, method: any) => { @@ -24,7 +24,7 @@ export function createActions( return obj }, {} as any) - return service as TReduxed + return service as RPCActions } export interface IState { @@ -38,7 +38,7 @@ export function createReducer( ) { const self = { - withHandler>( + withHandler>( handleAction: (state: State, action: TResolvedActions) => State, ): (state: State | undefined, action: TAllActions) => State { return (state: State = defaultState, action: TAllActions): State => { @@ -66,8 +66,8 @@ export function createReducer( }, action) } }, - withMapping>( - handlers: TReduxHandlers, + withMapping>( + handlers: RPCReduxHandlers, ) { return self.withHandler((state, action) => { if (action.method in handlers) { diff --git a/packages/jsonrpc/src/remote.test.ts b/packages/jsonrpc/src/remote.test.ts index cafe46a..5823c2c 100644 --- a/packages/jsonrpc/src/remote.test.ts +++ b/packages/jsonrpc/src/remote.test.ts @@ -10,7 +10,7 @@ import {createRemoteClient} from './remote' import {jsonrpc} from './express' import {keys} from 'ts-transformer-keys' import {noopLogger} from './test-utils' -import {Contextual} from './types' +import {WithContext} from './types' describe('remote', () => { @@ -21,7 +21,7 @@ describe('remote', () => { } const IServiceKeys = keys() - class Service implements Contextual { + class Service implements WithContext { add(ctx: {}, a: number, b: number) { return a + b } diff --git a/packages/jsonrpc/src/remote.ts b/packages/jsonrpc/src/remote.ts index 21cc904..9e4f119 100644 --- a/packages/jsonrpc/src/remote.ts +++ b/packages/jsonrpc/src/remote.ts @@ -1,5 +1,5 @@ import Axios from 'axios' -import {FunctionPropertyNames, TAsyncified} from './types' +import {FunctionPropertyNames, RPCClient} from './types' import {IDEMPOTENT_METHOD_REGEX} from './idempotent' export type TRequestIdGenerator = () => T @@ -51,5 +51,5 @@ export function createRemoteClient( return obj }, {} as any) - return service as TAsyncified + return service as RPCClient } diff --git a/packages/jsonrpc/src/supertest.ts b/packages/jsonrpc/src/supertest.ts index 46fbc55..d5e8c9b 100644 --- a/packages/jsonrpc/src/supertest.ts +++ b/packages/jsonrpc/src/supertest.ts @@ -1,6 +1,6 @@ import request from 'supertest' import {Application} from 'express' -import {TAsyncified} from './types' +import {RPCClient} from './types' export function createClient(app: Application, path: string, ) { @@ -25,5 +25,5 @@ export function createClient(app: Application, path: string, } }, }) - return proxy as TAsyncified + return proxy as RPCClient } diff --git a/packages/jsonrpc/src/types.ts b/packages/jsonrpc/src/types.ts index 654e4ec..5313a22 100644 --- a/packages/jsonrpc/src/types.ts +++ b/packages/jsonrpc/src/types.ts @@ -12,14 +12,14 @@ type PromisifyReturnType = (...a: ArgumentTypes) => * Helps implement a service from a service definiton that has a context as a * last argument. */ -export type Contextual = { +export type WithContext = { [K in keyof T]: T[K] extends (...args: infer A) => infer R ? (cx: Cx, ...args: A) => R : never } -export type ReverseContextual = { +export type WithoutContext = { [K in keyof T]: T[K] extends (cx: any, ...args: infer A) => infer R ? (...args: A) => R : @@ -34,20 +34,20 @@ export type FunctionPropertyNames = { : never }[keyof T] -export type TAsyncified = { +export type RPCClient = { [K in keyof T]: PromisifyReturnType } -export interface IReduxed { +export interface IRPCActions { [key: string]: (...a: any[]) => IRPCPendingAction } -export type TReduxed = { +export type RPCActions = { [K in keyof T]: (...a: ArgumentTypes) => IRPCPendingAction>, ActionType, K> } -export type TReduxHandlers = { +export type RPCReduxHandlers = { [K in keyof T]: ( state: State, action: TResolved>>, diff --git a/packages/server/src/rpc/RPC.ts b/packages/server/src/rpc/RPC.ts index dc17c41..075a21c 100644 --- a/packages/server/src/rpc/RPC.ts +++ b/packages/server/src/rpc/RPC.ts @@ -1,8 +1,8 @@ import { IContext } from '@rondo.dev/common' -import { Contextual, ensure } from '@rondo.dev/jsonrpc' +import { WithContext, ensure } from '@rondo.dev/jsonrpc' export { IContext } -export type RPC = Contextual +export type RPC = WithContext export const ensureLoggedIn = ensure( c => !!c.user && !!c.user.id, diff --git a/packages/server/src/test-utils/TestUtils.ts b/packages/server/src/test-utils/TestUtils.ts index 8621758..56d5cc0 100644 --- a/packages/server/src/test-utils/TestUtils.ts +++ b/packages/server/src/test-utils/TestUtils.ts @@ -11,7 +11,7 @@ import {Role} from '../entities/Role' import {CORRELATION_ID} from '../middleware' import shortid from 'shortid' import { AddressInfo } from 'net' -import { createRemoteClient, FunctionPropertyNames, TAsyncified } from '@rondo.dev/jsonrpc' +import { createRemoteClient, FunctionPropertyNames, RPCClient } from '@rondo.dev/jsonrpc' import {Server} from 'http' import { IAppServer } from '../application/IAppServer' @@ -198,7 +198,7 @@ export class TestUtils { return obj }, {} as any) - return service as TAsyncified + return service as RPCClient } private getCookies(setCookiesString: string[]): string {