app/types/data.d.ts

import ApiResource from "~/models/ApiResource";

type AnyJson = Record<string, any>

export const enum HTTP_METHOD {
    POST = 'POST',
    PUT = 'PUT',
    GET = 'GET',
    DELETE = 'DELETE'
}

interface AssociativeArray {
    [key: string]: any;
}

interface Connector {
    request(
        method: HTTP_METHOD,
        url: string,
        body: null | any,
        params: null | AssociativeArray,
        query: null | AssociativeArray
    )
}

export const enum METADATA_TYPE {
    ITEM,
    COLLECTION
}

interface HydraMetadata {
    readonly totalItems?: number
    firstPage?: number
    lastPage?: number
    nextPage?: number
    previousPage?: number
    type?: METADATA_TYPE
}

interface ApiResponse {
    data: AnyJson
    metadata: HydraMetadata
}

interface ApiCollection extends ApiResponse {
    data: AnyJson
    metadata: HydraMetadata
}

interface Collection {
    items: Array<ApiResource>
    totalItems: number | undefined
    firstPage: number | undefined
    lastPage: number | undefined
    nextPage: number | undefined
    previousPage: number | undefined
}