import axios , { type Method } from 'axios' import {objectToSnakeCase} from '@/helpers/case' import {getToken} from '@/helpers/auth' import AbstractModel, { type IAbstract } from '@/models/abstractModel' import type { Right } from '@/models/constants/rights' import type { IFile } from '@/models/file' interface Paths { create : string get : string getAll : string update : string delete : string reset?: string } function convertObject(o: Record) { if (o instanceof Date) { return o.toISOString() } return o } function prepareParams(params: Record) { if (typeof params !== 'object') { return params } for (const p in params) { if (Array.isArray(params[p])) { params[p] = params[p].map(convertObject) continue } params[p] = convertObject(params[p]) } return objectToSnakeCase(params) } export default class AbstractService { ///////////////////////////// // Initial variable definitions /////////////////////////// http loading = false uploadProgress = 0 paths: Paths = { create: '', get: '', getAll: '', update: '', delete: '', } // This contains the total number of pages and the number of results for the current page totalPages = 0 resultCount = 0 ///////////// // Service init /////////// /** * The abstract constructor. * @param [paths] An object with all paths. */ constructor(paths : Partial = {}) { this.http = axios.create({ baseURL: window.API_URL, headers: { 'Content-Type': 'application/json' }, }) // Set the interceptors to process every request this.http.interceptors.request.use((config) => { switch (config.method) { case 'post': if (this.useUpdateInterceptor()) { config.data = this.beforeUpdate(config.data) config.data = objectToSnakeCase(config.data) } break case 'put': if (this.useCreateInterceptor()) { config.data = this.beforeCreate(config.data) config.data = objectToSnakeCase(config.data) } break case 'delete': if (this.useDeleteInterceptor()) { config.data = this.beforeDelete(config.data) config.data = objectToSnakeCase(config.data) } break } return config }) // Set the default auth header if we have a token const token = getToken() if (token !== null) { this.http.defaults.headers.common['Authorization'] = `Bearer ${token}` } Object.assign(this.paths, paths) } /** * Whether or not to use the create interceptor which processes a request payload into json */ useCreateInterceptor(): boolean { return true } /** * Whether or not to use the update interceptor which processes a request payload into json */ useUpdateInterceptor(): boolean { return true } /** * Whether or not to use the delete interceptor which processes a request payload into json */ useDeleteInterceptor(): boolean { return true } ///////////////// // Helper functions /////////////// /** * Returns an object with all route parameters and their values. */ getRouteReplacements(route : string, parameters : Record = {}) { const replace$$1: Record = {} let pattern = this.getRouteParameterPattern() pattern = new RegExp(pattern instanceof RegExp ? pattern.source : pattern, 'g') for (let parameter; (parameter = pattern.exec(route)) !== null;) { replace$$1[parameter[0]] = parameters[parameter[1]] } return replace$$1 } /** * Holds the replacement pattern for url paths, can be overwritten by implementations. */ getRouteParameterPattern(): RegExp { return /{([^}]+)}/ } /** * Returns a fully-ready-ready-to-make-a-request-to route with replaced parameters. */ getReplacedRoute(path : string, pathparams : {}) : string { const replacements = this.getRouteReplacements(path, pathparams) return Object.entries(replacements).reduce( (result, [parameter, value]) => result.replace(parameter, value as string), path, ) } /** * setLoading is a method which sets the loading variable to true, after a timeout of 100ms. * It has the timeout to prevent the loading indicator from showing for only a blink of an eye in the * case the api returns a response in < 100ms. * But because the timeout is created using setTimeout, it will still trigger even if the request is * already finished, so we return a method to call in that case. */ setLoading() { const timeout = setTimeout(() => { this.loading = true }, 100) return () => { clearTimeout(timeout) this.loading = false } } ////////////////// // Default factories // It is possible to specify a factory for each type of request. // This makes it possible to have different models returned from different routes. // Specific factories for each request are completly optional, if these are not specified, the defautl factory is used. //////////////// /** * The modelFactory returns an model from an object. * This one here is the default one, usually the service definitions for a model will override this. */ modelFactory(data : Partial) { return new AbstractModel(data) } /** * This is the model factory for get requests. */ modelGetFactory(data : Partial) { return this.modelFactory(data) } /** * This is the model factory for get all requests. */ modelGetAllFactory(data : Partial) { return this.modelFactory(data) } /** * This is the model factory for create requests. */ modelCreateFactory(data : Partial) { return this.modelFactory(data) } /** * This is the model factory for update requests. */ modelUpdateFactory(data : Partial) { return this.modelFactory(data) } ////////////// // Preprocessors //////////// /** * Default preprocessor for get requests */ beforeGet(model : Model) { return model } /** * Default preprocessor for create requests */ beforeCreate(model : Model) { return model } /** * Default preprocessor for update requests */ beforeUpdate(model : Model) { return model } /** * Default preprocessor for delete requests */ beforeDelete(model : Model) { return model } /////////////// // Global actions ///////////// /** * Performs a get request to the url specified before. * @param model The model to use. The request path is built using the values from the model. * @param params Optional query parameters */ get(model : Model, params = {}) { if (this.paths.get === '') { throw new Error('This model is not able to get data.') } return this.getM(this.paths.get, model, params) } /** * This is a more abstract implementation which only does a get request. * Services which need more flexibility can use this. */ async getM(url : string, model : Model = new AbstractModel({}), params: Record = {}) { const cancel = this.setLoading() model = this.beforeGet(model) const finalUrl = this.getReplacedRoute(url, model) try { const response = await this.http.get(finalUrl, {params: prepareParams(params)}) const result = this.modelGetFactory(response.data) result.maxRight = Number(response.headers['x-max-right']) as Right return result } finally { cancel() } } async getBlobUrl(url : string, method : Method = 'GET', data = {}) { const response = await this.http({ url, method, responseType: 'blob', data, }) return window.URL.createObjectURL(new Blob([response.data])) } /** * Performs a get request to the url specified before. * The difference between this and get() is this one is used to get a bunch of data (an array), not just a single object. * @param model The model to use. The request path is built using the values from the model. * @param params Optional query parameters * @param page The page to get */ async getAll(model : Model = new AbstractModel({}), params = {}, page = 1) { if (this.paths.getAll === '') { throw new Error('This model is not able to get data.') } params.page = page const cancel = this.setLoading() model = this.beforeGet(model) const finalUrl = this.getReplacedRoute(this.paths.getAll, model) try { const response = await this.http.get(finalUrl, {params: prepareParams(params)}) this.resultCount = Number(response.headers['x-pagination-result-count']) this.totalPages = Number(response.headers['x-pagination-total-pages']) if (response.data === null) { return [] } if (Array.isArray(response.data)) { return response.data.map(entry => this.modelGetAllFactory(entry)) } return this.modelGetAllFactory(response.data) } finally { cancel() } } /** * Performs a put request to the url specified before * @returns {Promise} */ async create(model : Model) { if (this.paths.create === '') { throw new Error('This model is not able to create data.') } const cancel = this.setLoading() const finalUrl = this.getReplacedRoute(this.paths.create, model) try { const response = await this.http.put(finalUrl, model) const result = this.modelCreateFactory(response.data) if (typeof model.maxRight !== 'undefined') { result.maxRight = model.maxRight } return result } finally { cancel() } } /** * An abstract implementation to send post requests. * Services can use this to implement functions to do post requests other than using the update method. */ async post(url : string, model : Model) { const cancel = this.setLoading() try { const response = await this.http.post(url, model) const result = this.modelUpdateFactory(response.data) if (typeof model.maxRight !== 'undefined') { result.maxRight = model.maxRight } return result } finally { cancel() } } /** * Performs a post request to the update url */ update(model : Model) { if (this.paths.update === '') { throw new Error('This model is not able to update data.') } const finalUrl = this.getReplacedRoute(this.paths.update, model) return this.post(finalUrl, model) } /** * Performs a delete request to the update url */ async delete(model : Model) { if (this.paths.delete === '') { throw new Error('This model is not able to delete data.') } const cancel = this.setLoading() const finalUrl = this.getReplacedRoute(this.paths.delete, model) try { const {data} = await this.http.delete(finalUrl, model) return data } finally { cancel() } } /** * Uploads a file to a url. * @param url * @param file {IFile} * @param fieldName The name of the field the file is uploaded to. */ uploadFile(url : string, file: IFile, fieldName : string) { return this.uploadBlob(url, new Blob([file]), fieldName, file.name) } /** * Uploads a blob to a url. */ uploadBlob(url : string, blob: Blob, fieldName: string, filename : string) { const data = new FormData() data.append(fieldName, blob, filename) return this.uploadFormData(url, data) } /** * Uploads a form data object. */ async uploadFormData(url : string, formData: FormData) { const cancel = this.setLoading() try { const response = await this.http.put( url, formData, { headers: { 'Content-Type': 'multipart/form-data; boundary=' + formData._boundary, }, onUploadProgress: progressEvent => { this.uploadProgress = Math.round((progressEvent.loaded * 100) / progressEvent.total) }, }, ) return this.modelCreateFactory(response.data) } finally { this.uploadProgress = 0 cancel() } } }