Add typescript interfaces for the endpoints and a basic ApiService

apps/client/src/app/services/api.service.ts

@@ -0,0 +1,44 @@
+import { HttpClient } from '@angular/common/http';
+import { Injectable } from '@angular/core';
+import { Observable } from 'rxjs';
+import {
+  Transaction,
+  User,
+  PagedCollection,
+} from '@money-sprouts/shared/domain';
+
+@Injectable({
+  providedIn: 'root',
+})
+export class ApiService {
+  /**
+   * TODO replace with .env variable
+   */
+  private baseUrl = 'http://localhost:8081';
+
+  constructor(private http: HttpClient) {}
+
+  getUsers(): Observable<PagedCollection<User>> {
+    return this.http.get<PagedCollection<User>>(`${this.baseUrl}/api/users/`);
+  }
+
+  getUserById(id: string): Observable<User> {
+    return this.http.get<User>(`${this.baseUrl}/api/users/${id}`);
+  }
+
+  getTransactions(): Observable<PagedCollection<Transaction>> {
+    return this.http.get<PagedCollection<Transaction>>(
+      `${this.baseUrl}/api/transactions/`
+    );
+  }
+
+  getTransactionById(id: string): Observable<Transaction> {
+    return this.http.get<Transaction>(`${this.baseUrl}/api/transactions/${id}`);
+  }
+
+  getTransactionsByUserId(userId: string): Observable<Transaction> {
+    return this.http.get<Transaction>(
+      `${this.baseUrl}/api/users/${userId}/transactions`
+    );
+  }
+}

apps/client/src/app/services/user.service.ts

@@ -2,11 +2,6 @@ import { Injectable } from '@angular/core';
 import { HttpClient } from '@angular/common/http';
 import { BehaviorSubject, Observable, map, of, tap } from 'rxjs';
 
-export interface User {
-  username: string;
-  avatar: string;
-}
-
 @Injectable({
   providedIn: 'root',
 })

libs/shared/domain/src/index.ts

@@ -1,2 +1,5 @@
-export * from './lib/models/user';
-export * from './lib/models/transaction';
+export * from './interfaces/user';
+export * from './interfaces/transaction';
+export * from './interfaces/types';
+export * from './interfaces/ApiResource';
+export * from './interfaces/Collection';

libs/shared/domain/src/interfaces/Collection.ts

@@ -0,0 +1,21 @@
+import { ApiResource } from './types';
+
+export interface Pagination {
+  'hydra:first'?: string;
+  'hydra:previous'?: string;
+  'hydra:next'?: string;
+  'hydra:last'?: string;
+}
+
+export interface PagedCollection<T> extends ApiResource {
+  '@context'?: string;
+  '@type'?: string;
+  'hydra:firstPage'?: string;
+  'hydra:itemsPerPage'?: number;
+  'hydra:lastPage'?: string;
+  'hydra:member'?: T[];
+  'hydra:nextPage'?: string;
+  'hydra:search'?: object;
+  'hydra:totalItems'?: number;
+  'hydra:view'?: Pagination;
+}

libs/shared/domain/src/interfaces/dataAccess.ts

@@ -0,0 +1,13 @@
+export const normalizeLinks = (
+  value: string | string[] | undefined
+): string[] => {
+  if (!value) {
+    return [];
+  }
+
+  if (typeof value === "string") {
+    return value.split(",");
+  }
+
+  return value;
+};

libs/shared/domain/src/lib/interfaces/transaction.ts → libs/shared/domain/src/interfaces/transaction.ts

@@ -1,5 +1,5 @@
 export interface Transaction {
-  "@id"?: string;
+  '@id'?: string;
   title?: string;
   type?: number;
   value?: number;

libs/shared/domain/src/interfaces/types.ts

@@ -0,0 +1,22 @@
+export type TError = SubmissionError | Error | null;
+
+export interface ApiResource {
+  "@id": string;
+}
+
+export interface SubmissionErrors {
+  [p: string]: string;
+}
+
+export class SubmissionError extends Error {
+  private readonly _errors: SubmissionErrors;
+
+  constructor(message: string, errors: SubmissionErrors) {
+    super(message);
+    this._errors = errors;
+  }
+
+  public get errors(): SubmissionErrors {
+    return this._errors;
+  }
+}

libs/shared/domain/src/lib/interfaces/user.ts → libs/shared/domain/src/interfaces/user.ts

@@ -1,8 +1,8 @@
 export interface User {
-  "@id"?: string;
+  '@id'?: string;
   email?: string;
   name?: string;
-  roles?: any;
+  roles?: string[];
   password?: string;
   allowance?: number;
   nextPayday?: Date;

package.json

@@ -7,7 +7,7 @@
     "start-client": "nx serve client",
     "start-server": "nx serve server",
     "build:dev": "nx run client:build --configuration=development",
-    "generate:interfaces": "npm init @api-platform/client http://localhost:8101/api/ libs/shared/domain/src/lib/ -- --generator typescript"
+    "generate:interfaces": "npm init @api-platform/client http://localhost:8101/api/ libs/shared/domain/src/ -- --generator typescript"
   },
   "private": true,
   "dependencies": {

src/Factory/UserFactory.php

@@ -45,7 +45,10 @@ protected function getDefaults(): array
             'email' => self::faker()->email,
             'name' => self::faker()->firstName,
             'password' => self::faker()->password,
-            'avatar' => self::faker()->randomElement(['/build/assets/images/avatar_female.png', '/build/assets/images/avatar_male.png']),
+            'avatar' => self::faker()->randomElement([
+                '/build/assets/images/avatar_female.png',
+                '/build/assets/images/avatar_male.png'
+            ]),
             'roles' => [UserRole::USER],
         ];
     }