Advanced level typescript implementation of API response handling

advanced-typescript-api-response.ts

<!-- common payload: stats associated with data -->
type StatsRange = {
  max: number, min: number
}

type StatsKeys = 'count' | 'aum' | 'priceusd' | 'value'

type PartialStats<
  T extends Partial<{
    [key in StatsKeys]: any;
  }> = {
    [key in StatsKeys]: any;
  },
> = {
  stats?: {
    [key in keyof T]?: StatsRange;
  };
};

<!-- common payload: pagination info -->
type Pagination = {
  pagination?: {
    currentPage: number,
    perPage: number,
    total: number,
    totalPages: number
  }
}

<!-- api: onboarding data -->
type APIResponseOnboards = {
  count: number,
  unixTimeStamp: number,
  timestamp: string,
}

<!-- api: historical data -->
type APIResponseHistorical = {
  aum: number,
  unixTimeStamp: number,
}

<!-- api: wallets data -->
type APIResponseWallets = {
  wid: number,
  tenant: number,
  portfolioValue: number,
  address: string,
}

<!-- all api data handling -->
type GroupedResponse<T> = (
  { data: T[]} | { data: T[]; field: string; grouping: string}
)[]

type DataServiceResponse<
  BasePayload extends Record<string, any>,
  DataShape extends BasePayload | Array<BasePayload> = BasePayload,
> = {
  data: DataShape;
} & (DataShape extends Array<any> ? Pagination : null) &
  (BasePayload extends Partial<{ [k in StatsKeys]: number }>
    ? PartialStats<BasePayload>
    : null);