blob: b7a1928fc0dbc6a753bf867c21a86fed34d7d092 [file] [log] [blame]
const CC_API_BASE_URL = 'https://support.google.com/s/community/api/';
const apiErrors = {
0: 'OK',
1: 'CANCELLED',
2: 'UNKNOWN',
3: 'INVALID_ARGUMENT',
4: 'DEADLINE_EXCEEDED',
5: 'NOT_FOUND',
6: 'ALREADY_EXISTS',
7: 'PERMISSION_DENIED',
8: 'RESOURCE_EXHAUSTED',
9: 'FAILED_PRECONDITION',
10: 'ABORTED',
11: 'OUT_OF_RANGE',
12: 'UNIMPLEMENTED',
13: 'INTERNAL',
14: 'UNAVAILABLE',
15: 'DATA_LOSS',
16: 'UNAUTHENTICATED',
};
export const XClientHeader = 'X-Client';
export const XClientValue = 'twpt';
// Function to wrap calls to the Community Console API with intelligent error
// handling.
export function CCApi(
method, data, authenticated, authuser = 0,
returnUnauthorizedStatus = false) {
let authuserPart =
authuser == '0' ? '' : '?authuser=' + encodeURIComponent(authuser);
let context;
// #!if browser_target == 'gecko'
// See
// https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Content_scripts#xhr_and_fetch
// and https://developer.mozilla.org/en-US/docs/Web/API/Window/content.
context = window.content || window;
// #!else
context = window;
// #!endif
return context
.fetch(CC_API_BASE_URL + method + authuserPart, {
'headers': {
'content-type': 'text/plain; charset=utf-8',
// Used to exclude our requests from being handled by FetchProxy.
// FetchProxy will remove this header.
[XClientHeader]: XClientValue,
},
'body': JSON.stringify(data),
'method': 'POST',
'mode': 'cors',
'credentials': (authenticated ? 'include' : 'omit'),
})
.then(res => {
if (res.status == 200 || res.status == 400) {
return res.json().then(data => ({
status: res.status,
body: data,
}));
} else {
throw new Error(
'Status code ' + res.status + ' was not expected when calling ' +
method + '.');
}
})
.then(res => {
if (res.status == 400) {
// If the canonicalCode is PERMISSION_DENIED:
if (returnUnauthorizedStatus && res.body?.[2] == 7)
return {
unauthorized: true,
};
throw new Error(
res.body[4] ||
('Response status 400 for method ' + method + '. ' +
'Error code: ' +
(apiErrors[res.body?.[2]] ?? res.body?.[2] ?? 'unknown')));
}
if (returnUnauthorizedStatus)
return {
unauthorized: false,
body: res.body,
};
return res.body;
});
}