Path: blob/1.0-develop/resources/scripts/api/http.ts
10263 views
import axios, { AxiosInstance } from 'axios';1import { store } from '@/state';23const http: AxiosInstance = axios.create({4withCredentials: true,5timeout: 20000,6headers: {7'X-Requested-With': 'XMLHttpRequest',8Accept: 'application/json',9'Content-Type': 'application/json',10},11});1213http.interceptors.request.use((req) => {14if (!req.url?.endsWith('/resources')) {15store.getActions().progress.startContinuous();16}1718return req;19});2021http.interceptors.response.use(22(resp) => {23if (!resp.request?.url?.endsWith('/resources')) {24store.getActions().progress.setComplete();25}2627return resp;28},29(error) => {30store.getActions().progress.setComplete();3132throw error;33}34);3536export default http;3738/**39* Converts an error into a human readable response. Mostly just a generic helper to40* make sure we display the message from the server back to the user if we can.41*/42export function httpErrorToHuman(error: any): string {43if (error.response && error.response.data) {44let { data } = error.response;4546// Some non-JSON requests can still return the error as a JSON block. In those cases, attempt47// to parse it into JSON so we can display an actual error.48if (typeof data === 'string') {49try {50data = JSON.parse(data);51} catch (e) {52// do nothing, bad json53}54}5556if (data.errors && data.errors[0] && data.errors[0].detail) {57return data.errors[0].detail;58}5960// Errors from wings directory, mostly just for file uploads.61if (data.error && typeof data.error === 'string') {62return data.error;63}64}6566return error.message;67}6869export interface FractalResponseData {70object: string;71attributes: {72[k: string]: any;73relationships?: Record<string, FractalResponseData | FractalResponseList | null | undefined>;74};75}7677export interface FractalResponseList {78object: 'list';79data: FractalResponseData[];80}8182export interface FractalPaginatedResponse extends FractalResponseList {83meta: {84pagination: {85total: number;86count: number;87/* eslint-disable camelcase */88per_page: number;89current_page: number;90total_pages: number;91/* eslint-enable camelcase */92};93};94}9596export interface PaginatedResult<T> {97items: T[];98pagination: PaginationDataSet;99}100101export interface PaginationDataSet {102total: number;103count: number;104perPage: number;105currentPage: number;106totalPages: number;107}108109export function getPaginationSet(data: any): PaginationDataSet {110return {111total: data.total,112count: data.count,113perPage: data.per_page,114currentPage: data.current_page,115totalPages: data.total_pages,116};117}118119type QueryBuilderFilterValue = string | number | boolean | null;120121export interface QueryBuilderParams<FilterKeys extends string = string, SortKeys extends string = string> {122page?: number;123filters?: {124[K in FilterKeys]?: QueryBuilderFilterValue | Readonly<QueryBuilderFilterValue[]>;125};126sorts?: {127[K in SortKeys]?: -1 | 0 | 1 | 'asc' | 'desc' | null;128};129}130131/**132* Helper function that parses a data object provided and builds query parameters133* for the Laravel Query Builder package automatically. This will apply sorts and134* filters deterministically based on the provided values.135*/136export const withQueryBuilderParams = (data?: QueryBuilderParams): Record<string, unknown> => {137if (!data) return {};138139const filters = Object.keys(data.filters || {}).reduce((obj, key) => {140const value = data.filters?.[key];141142return !value || value === '' ? obj : { ...obj, [`filter[${key}]`]: value };143}, {} as NonNullable<QueryBuilderParams['filters']>);144145const sorts = Object.keys(data.sorts || {}).reduce((arr, key) => {146const value = data.sorts?.[key];147if (!value || !['asc', 'desc', 1, -1].includes(value)) {148return arr;149}150151return [...arr, (value === -1 || value === 'desc' ? '-' : '') + key];152}, [] as string[]);153154return {155...filters,156sort: !sorts.length ? undefined : sorts.join(','),157page: data.page,158};159};160161162