This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
outline/app/utils/ApiClient.js

156 lines
3.8 KiB
JavaScript

// @flow
import invariant from "invariant";
import { map, trim } from "lodash";
import stores from "stores";
import download from "./download";
import {
AuthorizationError,
NetworkError,
NotFoundError,
OfflineError,
RequestError,
UpdateRequiredError,
} from "./errors";
type Options = {
baseUrl?: string,
};
class ApiClient {
baseUrl: string;
userAgent: string;
constructor(options: Options = {}) {
this.baseUrl = options.baseUrl || "/api";
this.userAgent = "OutlineFrontend";
}
fetch = async (
path: string,
method: string,
data: ?Object,
options: Object = {}
) => {
let body;
let modifiedPath;
let urlToFetch;
if (method === "GET") {
if (data) {
modifiedPath = `${path}?${data && this.constructQueryString(data)}`;
} else {
modifiedPath = path;
}
} else if (method === "POST" || method === "PUT") {
body = data ? JSON.stringify(data) : undefined;
}
if (path.match(/^http/)) {
urlToFetch = modifiedPath || path;
} else {
urlToFetch = this.baseUrl + (modifiedPath || path);
}
// Construct headers
const headers = new Headers({
Accept: "application/json",
"Content-Type": "application/json",
"cache-control": "no-cache",
"x-editor-version": EDITOR_VERSION,
pragma: "no-cache",
});
if (stores.auth.authenticated) {
invariant(stores.auth.token, "JWT token not set properly");
headers.set("Authorization", `Bearer ${stores.auth.token}`);
}
let response;
try {
response = await fetch(urlToFetch, {
method,
body,
headers,
redirect: "follow",
credentials: "omit",
cache: "no-cache",
});
} catch (err) {
if (window.navigator.onLine) {
throw new NetworkError("A network error occurred, try again?");
} else {
throw new OfflineError("No internet connection available");
}
}
const success = response.status >= 200 && response.status < 300;
if (options.download && success) {
const blob = await response.blob();
const fileName = (
response.headers.get("content-disposition") || ""
).split("filename=")[1];
download(blob, trim(fileName, '"'));
return;
} else if (success) {
return response.json();
}
// Handle 401, log out user
if (response.status === 401) {
stores.auth.logout();
return;
}
// Handle failed responses
const error = {};
error.statusCode = response.status;
error.response = response;
try {
const parsed = await response.json();
error.message = parsed.message || "";
error.error = parsed.error;
error.data = parsed.data;
} catch (_err) {
// we're trying to parse an error so JSON may not be valid
}
if (response.status === 400 && error.error === "editor_update_required") {
window.location.reload(true);
throw new UpdateRequiredError(error.message);
}
if (response.status === 403) {
throw new AuthorizationError(error.message);
}
if (response.status === 404) {
throw new NotFoundError(error.message);
}
throw new RequestError(error.message);
};
get = (path: string, data: ?Object, options?: Object) => {
return this.fetch(path, "GET", data, options);
};
post = (path: string, data: ?Object, options?: Object) => {
return this.fetch(path, "POST", data, options);
};
// Helpers
constructQueryString = (data: { [key: string]: string }) => {
return map(
data,
(v, k) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`
).join("&");
};
}
export default ApiClient;
// In case you don't want to always initiate, just import with `import { client } ...`
export const client = new ApiClient();