mirror of
				https://github.com/mealie-recipes/mealie.git
				synced 2025-10-30 17:53:31 -04:00 
			
		
		
		
	rewrite get_all routes to use a pagination pattern to allow for better implementations of search, filter, and sorting on the frontend or by any client without fetching all the data. Additionally we added a CI check for running the Nuxt built to confirm that no TS errors were present. Finally, I had to remove the header support for the Shopping lists as the browser caching based off last_updated header was not allowing it to read recent updates due to how we're handling the updated_at property in the database with nested fields. This will have to be looked at in the future to reimplement. I'm unsure how many other routes have a similar issue. Co-authored-by: Hayden <64056131+hay-kot@users.noreply.github.com>
		
			
				
	
	
		
			51 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			51 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
| import { ApiRequestInstance, PaginationData } from "~/types/api";
 | |
| 
 | |
| export interface CrudAPIInterface {
 | |
|   requests: ApiRequestInstance;
 | |
| 
 | |
|   // Route Properties / Methods
 | |
|   baseRoute: string;
 | |
|   itemRoute(itemId: string | number): string;
 | |
| 
 | |
|   // Methods
 | |
| }
 | |
| 
 | |
| export abstract class BaseAPI {
 | |
|   requests: ApiRequestInstance;
 | |
| 
 | |
|   constructor(requests: ApiRequestInstance) {
 | |
|     this.requests = requests;
 | |
|   }
 | |
| }
 | |
| 
 | |
| export abstract class BaseCRUDAPI<CreateType, ReadType, UpdateType = CreateType> extends BaseAPI implements CrudAPIInterface {
 | |
|   abstract baseRoute: string;
 | |
|   abstract itemRoute(itemId: string | number): string;
 | |
| 
 | |
|   async getAll(page = 1, perPage = -1, params = {} as any) {
 | |
|     return await this.requests.get<PaginationData<ReadType>>(this.baseRoute, {
 | |
|       params: { page, perPage, ...params },
 | |
|     });
 | |
|   }
 | |
| 
 | |
|   async createOne(payload: CreateType) {
 | |
|     return await this.requests.post<ReadType>(this.baseRoute, payload);
 | |
|   }
 | |
| 
 | |
|   async getOne(itemId: string | number) {
 | |
|     return await this.requests.get<ReadType>(this.itemRoute(itemId));
 | |
|   }
 | |
| 
 | |
|   async updateOne(itemId: string | number, payload: UpdateType) {
 | |
|     return await this.requests.put<ReadType, UpdateType>(this.itemRoute(itemId), payload);
 | |
|   }
 | |
| 
 | |
|   async patchOne(itemId: string, payload: Partial<UpdateType>) {
 | |
|     return await this.requests.patch<ReadType, Partial<UpdateType>>(this.itemRoute(itemId), payload);
 | |
|   }
 | |
| 
 | |
|   async deleteOne(itemId: string | number) {
 | |
|     return await this.requests.delete<ReadType>(this.itemRoute(itemId));
 | |
|   }
 | |
| }
 |