Restructured client architecture. Added security client

Author: jusexton

.eslintrc.js

@@ -12,5 +12,6 @@ module.exports = {
   rules: {
     // Place to specify ESLint rules. Can be used to overwrite rules specified from the extended configs
     // e.g. "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-explicit-any": "off",
   },
 };

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.2.0
+
+- Added security client
+  - Login functionality
+  - Confirm account functionality
+- Restructured client architecture. All clients now fall under a portfolio client.
+
 # 0.1.2
 
 - Fixed bug that incorrectly configured default api URL with extra trailing slash

src/apis/contact/client.ts

@@ -1,12 +1,41 @@
-import { ClientConfig, Configurable } from "../../common/config";
-import { ContactMessageService } from "./messages";
+import axios, { AxiosInstance, AxiosResponse } from "axios";
+import { BaseClient, ClientConfig } from "../../common/client";
+import { axiosRequestConfig, PortfolioRequest } from "../../common/request";
+import { PortfolioResponse } from "../../common/response";
+import { ContactMessage, Reason, Sender } from "./models";
 
-export class ContactClient implements Configurable {
-  readonly config: ClientConfig;
-  readonly messages: ContactMessageService;
+export type CreateContactMessageRequest = PortfolioRequest<
+  CreateContactMessageForm
+>;
 
-  constructor(config: ClientConfig) {
-    this.config = config;
-    this.messages = new ContactMessageService(config);
+export interface CreateContactMessageForm {
+  message: string;
+  reason: Reason;
+  sender: Sender;
+}
+
+export type ContactMessageResponse = PortfolioResponse<ContactMessage>;
+
+export class ContactClient extends BaseClient {
+  constructor(config: ClientConfig, axiosInstance: AxiosInstance = axios) {
+    super(config, axiosInstance);
+  }
+
+  /**
+   * Creates a new contact message
+   *
+   * @param request Sent to portfolio API
+   */
+  createMessage(
+    request: CreateContactMessageRequest
+  ): Promise<AxiosResponse<ContactMessageResponse>> {
+    const url = `${this.config.host}/mail`;
+    const config = axiosRequestConfig(request);
+
+    return this.axiosInstance.post<ContactMessageResponse>(
+      url,
+      request.body,
+      config
+    );
   }
 }

src/apis/contact/index.ts

@@ -0,0 +1,33 @@
+import { ClientConfig } from "../common/client";
+import { ContactClient } from "./contact/client";
+import { SecurityClient } from "./security/client";
+
+const defaultConfig: ClientConfig = {
+  host: "https://b623pa888e.execute-api.us-east-2.amazonaws.com/api",
+};
+
+export class PortfolioClient {
+  readonly config: ClientConfig;
+  readonly contact: ContactClient;
+  readonly security: SecurityClient;
+
+  constructor(config: ClientConfig) {
+    this.config = config;
+    this.contact = new ContactClient(config);
+    this.security = new SecurityClient(config);
+  }
+}
+
+/**
+ * Factory method used for configuring and building a new contact client.
+ */
+export const portfolio = (
+  config: ClientConfig = defaultConfig
+): PortfolioClient => {
+  return new PortfolioClient(config);
+};
+
+export * from "./contact/client";
+export * from "./contact/models";
+export * from "./security/client";
+export * from "./security/models";

src/apis/contact/messages.ts

@@ -0,0 +1,43 @@
+import axios, { AxiosInstance, AxiosResponse } from "axios";
+import { BaseClient, ClientConfig, PortfolioResponse } from "../../common";
+import { axiosRequestConfig, PortfolioRequest } from "../../common/request";
+import { TokenBody } from "./models";
+
+export type LoginRequest = PortfolioRequest<LoginForm>;
+
+export interface LoginForm {
+  username: string;
+  password: string;
+}
+
+export type LoginResponse = PortfolioResponse<TokenBody>;
+
+export type UpdatePasswordRequest = PortfolioRequest<UpdatePasswordForm>;
+
+export interface UpdatePasswordForm {
+  username: string;
+  oldPassword: string;
+  newPassword: string;
+}
+
+export class SecurityClient extends BaseClient {
+  constructor(config: ClientConfig, axiosInstance: AxiosInstance = axios) {
+    super(config, axiosInstance);
+  }
+
+  login(request: LoginRequest): Promise<AxiosResponse<LoginResponse>> {
+    const url = `${this.config.host}/login`;
+    const config = axiosRequestConfig(request);
+
+    return this.axiosInstance.post<LoginResponse>(url, request.body, config);
+  }
+
+  confirmAccount(
+    request: UpdatePasswordRequest
+  ): Promise<AxiosResponse<LoginResponse>> {
+    const url = `${this.config.host}/confirm-account`;
+    const config = axiosRequestConfig(request);
+
+    return this.axiosInstance.post<LoginResponse>(url, request.body, config);
+  }
+}

src/apis/index.ts

@@ -0,0 +1,6 @@
+export interface TokenBody {
+  idToken: string;
+  accessToken: string;
+  refreshToken: string;
+  tokenType: string;
+}

src/apis/security/client.ts

@@ -0,0 +1,16 @@
+import axios, { AxiosInstance } from "axios";
+
+export interface ClientConfig {
+  host: string;
+  jwt?: string;
+}
+
+export abstract class BaseClient {
+  readonly config: ClientConfig;
+  protected readonly axiosInstance: AxiosInstance;
+
+  constructor(config: ClientConfig, axiosInstance: AxiosInstance = axios) {
+    this.config = config;
+    this.axiosInstance = axiosInstance;
+  }
+}