Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2024-12-30 20:33:54 -05:00
Code Issues Activity

refactor(connector): make methods optional in BaseConnector class

Browse source
This commit is contained in:
Darcy Ye 2022-08-18 17:44:20 +08:00
parent c075fd1e68
commit dbd5fe354a
No known key found for this signature in database
GPG key ID: B46F4C07EDEFC610
1 changed files with 28 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
packages/connector-schemas/src/types.ts
View file

@ -43,20 +43,11 @@ export type ConnectorMetadata = {
configTemplate: string;
};
// We will have message type 'ForgotPassword' available in the near future.
type MessageTypes = 'SignIn' | 'Register' | 'Test';
type MessageTypes = 'SignIn' | 'Register' | 'ForgotPassword' | 'Test';
type SendMessageFunction = (
to: string,
type: MessageTypes,
payload: { code: string }
) => Promise<unknown>;
export type SendMessageByFunction<T = Record<string, unknown>> = (
config: T,
to: string,
type: MessageTypes,
payload: { code: string }
export type SendMessageFunction<T = Record<string, unknown>> = (
data: { to: string; type: MessageTypes; payload: { code: string } },
config?: T
) => Promise<unknown>;
export type ValidateConfig<T> = (config: unknown) => asserts config is T;
@ -74,42 +65,53 @@ export type GetConnectorConfig = (id: string) => Promise<unknown>;
export type AuthResponseParser<T = Record<string, unknown>> = (response: unknown) => Promise<T>;
abstract class BaseConnector<T> {
public getConfig: GetConnectorConfig;
class BaseConnector<T> {
public getConfig!: GetConnectorConfig;
public metadata!: ConnectorMetadata;
public sendMessage?: SendMessageFunction;
public sendTestMessage?: SendMessageFunction;
public getAuthorizationUri?: GetAuthorizationUri;
public getUserInfo?: GetUserInfo;
protected authResponseParser?: AuthResponseParser;
constructor(getConnectorConfig: GetConnectorConfig) {
this.getConfig = getConnectorConfig;
}
// eslint-disable-next-line @typescript-eslint/no-empty-function
public validateConfig: ValidateConfig<T> = async () => {};
// eslint-disable-next-line @typescript-eslint/no-empty-function
protected readonly sendMessageBy?: SendMessageFunction<T> = async () => {};
}
abstract class PasswordlessConnector<T> extends BaseConnector<T> {
protected abstract readonly sendMessageBy: SendMessageByFunction<T>;
class PasswordlessConnector<T> extends BaseConnector<T> {
protected readonly sendMessageBy!: SendMessageFunction<T>;
public sendMessage: SendMessageFunction = async (address, type, data) => {
public sendMessage: SendMessageFunction = async ({ to, type, payload }) => {
const config = await this.getConfig(this.metadata.id);
this.validateConfig(config);
return this.sendMessageBy(config, address, type, data);
return this.sendMessageBy({ to, type, payload }, config);
};
public sendTestMessage?: SendMessageByFunction = async (config, address, type, data) => {
public sendTestMessage?: SendMessageFunction = async ({ to, type, payload }, config) => {
this.validateConfig(config);
return this.sendMessageBy(config, address, type, data);
return this.sendMessageBy({ to, type, payload }, config);
};
}
export abstract class SmsConnector<T> extends PasswordlessConnector<T> {}
export class SmsConnector<T> extends PasswordlessConnector<T> {}
export abstract class EmailConnector<T> extends PasswordlessConnector<T> {}
export class EmailConnector<T> extends PasswordlessConnector<T> {}
export abstract class SocialConnector<T> extends BaseConnector<T> {
public abstract getAuthorizationUri: GetAuthorizationUri;
public abstract getUserInfo: GetUserInfo;
export class SocialConnector<T> extends BaseConnector<T> {
public getAuthorizationUri!: GetAuthorizationUri;
public getUserInfo!: GetUserInfo;
protected authResponseParser?: AuthResponseParser;
}