Merge pull request #11 from ge-tracker/typing

Add favourite items typing
ge-tracker · Oct 19, 2023 · 3bce04c · 3bce04c
2 parents cd7c337 + cc4c6e3
commit 3bce04c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 12 deletions.
diff --git a/src/endpoints/DashboardWrapper.ts b/src/endpoints/DashboardWrapper.ts
@@ -1,5 +1,5 @@
 import APIBaseWrapper from './APIBaseWrapper';
-import type {ItemArrayDataWrappedWithMeta, ItemDataWrapped} from '../types';
+import type {DataWrappedWithMeta, ItemDataWrapped} from '../types';
 
 export type DashboardTotal = {
   invested: number;
@@ -17,8 +17,8 @@ export type DashboardTiles = {
 };
 
 export type Dashboard = {
-  favouriteItems: ItemArrayDataWrappedWithMeta;
-  suggestedItems: ItemArrayDataWrappedWithMeta;
+  favouriteItems: DataWrappedWithMeta;
+  suggestedItems: DataWrappedWithMeta;
   tiles: {
     data: DashboardTiles;
   };

diff --git a/src/endpoints/FavouriteItemsWrapper.ts b/src/endpoints/FavouriteItemsWrapper.ts
@@ -1,13 +1,20 @@
 import APIBaseWrapper from './APIBaseWrapper';
+import type {Item, ItemListPromise} from '../types';
 
-export interface FavouriteItemReorder {
+export type FavouriteItemReorder = {
   item_id: number;
   order: number;
-}
+};
 
 export type FavouriteItemReorderRequest = Array<FavouriteItemReorder>;
 
+export type FavouriteItem = Item & {favouriteItemsId: number};
+
 export default class FavouriteItemsWrapper extends APIBaseWrapper {
+  getItems(): ItemListPromise<FavouriteItem> {
+    return this._wrapGet('favourite-items');
+  }
+
   addItem(itemId: number) {
     return this._wrapPost(`favourite-items`, {
       item_id: itemId,
@@ -22,10 +29,6 @@ export default class FavouriteItemsWrapper extends APIBaseWrapper {
     return this._wrapDelete(`favourite-items/itemId/${itemId}`);
   }
 
-  getItems(opts = {filters: false}) {
-    return this._wrapGet(this.parseOptions('favourite-items', opts));
-  }
-
   /**
    * Update favourite items sort order
    *

diff --git a/src/types.ts b/src/types.ts
@@ -53,12 +53,12 @@ export interface Item {
 
 export type MetaCount = {count: number};
 
-export type ItemListPromise = Promise<Item[]>;
-export type ItemPromise = Promise<Item>;
+export type ItemListPromise<T = Item> = Promise<T[]>;
+export type ItemPromise<T = Item> = Promise<T>;
 export type DataWrapped<T> = {data: T};
+export type DataWrappedWithMeta<T = Item> = {data: T[]; meta: MetaCount};
 export type ItemDataWrapped = DataWrapped<Item>;
 export type ItemArrayDataWrapped = DataWrapped<Item[]>;
-export type ItemArrayDataWrappedWithMeta = {data: Item[]; meta: MetaCount};
 
 export interface StatusResponse {
   status_code: number;
@@ -178,3 +178,5 @@ export type Paginated = {
 export type PaginatedResponse<T, PaginationType = LegacyPaginated> = {
   data: T[];
 } & PaginationType;
+
+export type MaybePromise<T> = T | Promise<T>;