decap-cms-lib-util 3.0.2 → 3.0.4

package/dist/esm/API.js

@@ -4,8 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.PreviewState = void 0;
+exports.apiRequest = apiRequest;
+exports.endpointConstants = exports.apiRoots = void 0;
+exports.getDefaultBranchName = getDefaultBranchName;
 exports.getPreviewStatus = getPreviewStatus;
 exports.isPreviewContext = isPreviewContext;
+exports.parseResponse = parseResponse;
 exports.readFile = readFile;
 exports.readFileMetadata = readFileMetadata;
 exports.requestWithBackoff = requestWithBackoff;
@@ -13,10 +17,15 @@ exports.throwOnConflictingBranches = throwOnConflictingBranches;
 var _asyncLock = require("./asyncLock");
 var _unsentRequest = _interopRequireDefault(require("./unsentRequest"));
 var _APIError = _interopRequireDefault(require("./APIError"));
+const _excluded = ["token", "backend"];
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _extendableBuiltin(cls) {
   function ExtendableBuiltin() {
     var instance = Reflect.construct(cls, Array.from(arguments));
@@ -51,6 +60,24 @@ class RateLimitError extends _extendableBuiltin(Error) {
     }
   }
 }
+async function parseJsonResponse(response) {
+  const json = await response.json();
+  if (!response.ok) {
+    return Promise.reject(json);
+  }
+  return json;
+}
+function parseResponse(response) {
+  const contentType = response.headers.get('Content-Type');
+  if (contentType && contentType.match(/json/)) {
+    return parseJsonResponse(response);
+  }
+  const textPromise = response.text().then(text => {
+    if (!response.ok) return Promise.reject(text);
+    return text;
+  });
+  return textPromise;
+}
 async function requestWithBackoff(api, req, attempt = 1) {
   if (api.rateLimiter) {
     await api.rateLimiter.acquire();
@@ -96,6 +123,133 @@ async function requestWithBackoff(api, req, attempt = 1) {
     }
   }
 }
+
+// Options is an object which contains all the standard network request properties
+// for modifying HTTP requests and may contains `params` property
+
+// RequestConfig contains all the standard properties of a Request object and
+// several custom properties:
+// - "headers" property is an object whose properties and values are string types
+// - `token` property to allow passing tokens for users using a private repo.
+// - `params` property for customizing response
+// - `backend`(compulsory) to specify which backend to be used: Github, Gitlab etc.
+
+const apiRoots = exports.apiRoots = {
+  github: 'https://api.github.com',
+  gitlab: 'https://gitlab.com/api/v4',
+  bitbucket: 'https://api.bitbucket.org/2.0'
+};
+const endpointConstants = exports.endpointConstants = {
+  singleRepo: {
+    bitbucket: '/repositories',
+    github: '/repos',
+    gitlab: '/projects'
+  }
+};
+const api = {
+  buildRequest(req) {
+    return req;
+  }
+};
+function constructUrlWithParams(url, params) {
+  if (params) {
+    const paramList = [];
+    for (const key in params) {
+      paramList.push(`${key}=${encodeURIComponent(params[key])}`);
+    }
+    if (paramList.length) {
+      url += `?${paramList.join('&')}`;
+    }
+  }
+  return url;
+}
+async function constructRequestHeaders(headerConfig) {
+  const {
+    token,
+    headers
+  } = headerConfig;
+  const baseHeaders = _objectSpread({
+    'Content-Type': 'application/json; charset=utf-8'
+  }, headers);
+  if (token) {
+    baseHeaders['Authorization'] = `token ${token}`;
+  }
+  return Promise.resolve(baseHeaders);
+}
+function handleRequestError(error, responseStatus, backend) {
+  throw new _APIError.default(error.message, responseStatus, backend);
+}
+async function apiRequest(path, config, parser = response => parseResponse(response)) {
+  const {
+      token,
+      backend
+    } = config,
+    props = _objectWithoutProperties(config, _excluded);
+  const options = _objectSpread({
+    cache: 'no-cache'
+  }, props);
+  const headers = await constructRequestHeaders({
+    headers: options.headers || {},
+    token
+  });
+  const baseUrl = apiRoots[backend];
+  const url = constructUrlWithParams(`${baseUrl}${path}`, options.params);
+  let responseStatus = 500;
+  try {
+    const req = _unsentRequest.default.fromFetchArguments(url, _objectSpread(_objectSpread({}, options), {}, {
+      headers
+    }));
+    const response = await requestWithBackoff(api, req);
+    responseStatus = response.status;
+    const parsedResponse = await parser(response);
+    return parsedResponse;
+  } catch (error) {
+    return handleRequestError(error, responseStatus, backend);
+  }
+}
+async function getDefaultBranchName(configs) {
+  let apiPath;
+  const {
+    token,
+    backend,
+    repo
+  } = configs;
+  switch (backend) {
+    case 'gitlab':
+      {
+        apiPath = `/projects/${encodeURIComponent(repo)}`;
+        break;
+      }
+    case 'bitbucket':
+      {
+        apiPath = `/repositories/${repo}`;
+        break;
+      }
+    default:
+      {
+        apiPath = `/repos/${repo}`;
+      }
+  }
+  const repoInfo = await apiRequest(apiPath, {
+    token,
+    backend
+  });
+  let defaultBranchName;
+  if (backend === 'bitbucket') {
+    const {
+      mainbranch: {
+        name
+      }
+    } = repoInfo;
+    defaultBranchName = name;
+  } else {
+    const {
+      default_branch
+    } = repoInfo;
+    defaultBranchName = default_branch;
+  }
+  return defaultBranchName;
+}
 async function readFile(id, fetchContent, localForage, isText) {
   const key = id ? isText ? `gh.${id}` : `gh.${id}.blob` : null;
   const cached = key ? await localForage.getItem(key) : null;

package/dist/esm/APIError.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.API_ERROR = void 0;
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _extendableBuiltin(cls) {
   function ExtendableBuiltin() {
     var instance = Reflect.construct(cls, Array.from(arguments));

package/dist/esm/AccessTokenError.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.ACCESS_TOKEN_ERROR = void 0;
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _extendableBuiltin(cls) {
   function ExtendableBuiltin() {
     var instance = Reflect.construct(cls, Array.from(arguments));

package/dist/esm/Cursor.js

@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = exports.CURSOR_COMPATIBILITY_SYMBOL = void 0;
 var _immutable = require("immutable");
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function jsToMap(obj) {
   if (obj === undefined) {
     return (0, _immutable.Map)();

package/dist/esm/EditorialWorkflowError.js

@@ -5,8 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = exports.EDITORIAL_WORKFLOW_ERROR = void 0;
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _extendableBuiltin(cls) {
   function ExtendableBuiltin() {
     var instance = Reflect.construct(cls, Array.from(arguments));

package/dist/esm/git-lfs.js

@@ -19,8 +19,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
 function splitIntoLines(str) {

package/dist/esm/implementation.js

@@ -21,8 +21,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 const MAX_CONCURRENT_DOWNLOADS = 10;
 async function fetchFiles(files, readFile, readFileMetadata, apiName) {
   const sem = (0, _semaphore.default)(MAX_CONCURRENT_DOWNLOADS);

package/dist/esm/index.js

@@ -160,6 +160,12 @@ Object.defineProperty(exports, "getBlobSHA", {
     return _getBlobSHA.default;
   }
 });
+Object.defineProperty(exports, "getDefaultBranchName", {
+  enumerable: true,
+  get: function () {
+    return _API.getDefaultBranchName;
+  }
+});
 Object.defineProperty(exports, "getLargeMediaFilteredMediaFiles", {
   enumerable: true,
   get: function () {
@@ -396,6 +402,7 @@ const DecapCmsLibUtil = exports.DecapCmsLibUtil = {
   contentKeyFromBranch: _APIUtils.contentKeyFromBranch,
   blobToFileObj: _implementation.blobToFileObj,
   requestWithBackoff: _API.requestWithBackoff,
+  getDefaultBranchName: _API.getDefaultBranchName,
   allEntriesByFolder: _implementation.allEntriesByFolder,
   AccessTokenError: _AccessTokenError.default,
   throwOnConflictingBranches: _API.throwOnConflictingBranches

package/dist/esm/unsentRequest.js

@@ -12,8 +12,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
 function isAbortControllerSupported() {
   if (typeof window !== 'undefined') {
     return !!window.AbortController;

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "decap-cms-lib-util",
   "description": "Shared utilities for Decap CMS.",
-  "version": "3.0.2",
-  "repository": "https://github.com/decaporg/decap-cms/tree/master/packages/decap-cms-lib-util",
+  "version": "3.0.4",
+  "repository": "https://github.com/decaporg/decap-cms/tree/main/packages/decap-cms-lib-util",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
   "module": "dist/esm/index.js",
   "main": "dist/decap-cms-lib-util.js",
@@ -25,5 +25,5 @@
     "immutable": "^3.7.6",
     "lodash": "^4.17.11"
   },
-  "gitHead": "80fb16f775bc4a1ad026985ca85a2e9ee3f1e15c"
+  "gitHead": "d3678b0ad1b9f93b841c85e4ee2de48167aa8906"
 }

package/src/API.ts

@@ -40,6 +40,26 @@ class RateLimitError extends Error {
   }
 }
 
+async function parseJsonResponse(response: Response) {
+  const json = await response.json();
+  if (!response.ok) {
+    return Promise.reject(json);
+  }
+  return json;
+}
+
+export function parseResponse(response: Response) {
+  const contentType = response.headers.get('Content-Type');
+  if (contentType && contentType.match(/json/)) {
+    return parseJsonResponse(response);
+  }
+  const textPromise = response.text().then(text => {
+    if (!response.ok) return Promise.reject(text);
+    return text;
+  });
+  return textPromise;
+}
+
 export async function requestWithBackoff(
   api: API,
   req: ApiRequest,
@@ -96,6 +116,140 @@ export async function requestWithBackoff(
   }
 }
 
+// Options is an object which contains all the standard network request properties
+// for modifying HTTP requests and may contains `params` property
+
+type Param = string | number;
+
+type ParamObject = Record<string, Param>;
+
+type HeaderObj = Record<string, string>;
+
+type HeaderConfig = {
+  headers?: HeaderObj;
+  token?: string | undefined;
+};
+
+type Backend = 'github' | 'gitlab' | 'bitbucket';
+
+// RequestConfig contains all the standard properties of a Request object and
+// several custom properties:
+// - "headers" property is an object whose properties and values are string types
+// - `token` property to allow passing tokens for users using a private repo.
+// - `params` property for customizing response
+// - `backend`(compulsory) to specify which backend to be used: Github, Gitlab etc.
+
+type RequestConfig = Omit<RequestInit, 'headers'> &
+  HeaderConfig & {
+    backend: Backend;
+    params?: ParamObject;
+  };
+
+export const apiRoots = {
+  github: 'https://api.github.com',
+  gitlab: 'https://gitlab.com/api/v4',
+  bitbucket: 'https://api.bitbucket.org/2.0',
+};
+
+export const endpointConstants = {
+  singleRepo: {
+    bitbucket: '/repositories',
+    github: '/repos',
+    gitlab: '/projects',
+  },
+};
+
+const api = {
+  buildRequest(req: ApiRequest) {
+    return req;
+  },
+};
+
+function constructUrlWithParams(url: string, params?: ParamObject) {
+  if (params) {
+    const paramList = [];
+    for (const key in params) {
+      paramList.push(`${key}=${encodeURIComponent(params[key])}`);
+    }
+    if (paramList.length) {
+      url += `?${paramList.join('&')}`;
+    }
+  }
+  return url;
+}
+
+async function constructRequestHeaders(headerConfig: HeaderConfig) {
+  const { token, headers } = headerConfig;
+  const baseHeaders: HeaderObj = { 'Content-Type': 'application/json; charset=utf-8', ...headers };
+  if (token) {
+    baseHeaders['Authorization'] = `token ${token}`;
+  }
+  return Promise.resolve(baseHeaders);
+}
+
+function handleRequestError(error: FetchError, responseStatus: number, backend: Backend) {
+  throw new APIError(error.message, responseStatus, backend);
+}
+
+export async function apiRequest(
+  path: string,
+  config: RequestConfig,
+  parser = (response: Response) => parseResponse(response),
+) {
+  const { token, backend, ...props } = config;
+  const options = { cache: 'no-cache', ...props };
+  const headers = await constructRequestHeaders({ headers: options.headers || {}, token });
+  const baseUrl = apiRoots[backend];
+  const url = constructUrlWithParams(`${baseUrl}${path}`, options.params);
+  let responseStatus = 500;
+  try {
+    const req = unsentRequest.fromFetchArguments(url, {
+      ...options,
+      headers,
+    }) as unknown as ApiRequest;
+    const response = await requestWithBackoff(api, req);
+    responseStatus = response.status;
+    const parsedResponse = await parser(response);
+    return parsedResponse;
+  } catch (error) {
+    return handleRequestError(error, responseStatus, backend);
+  }
+}
+
+export async function getDefaultBranchName(configs: {
+  backend: Backend;
+  repo: string;
+  token?: string;
+}) {
+  let apiPath;
+  const { token, backend, repo } = configs;
+  switch (backend) {
+    case 'gitlab': {
+      apiPath = `/projects/${encodeURIComponent(repo)}`;
+      break;
+    }
+    case 'bitbucket': {
+      apiPath = `/repositories/${repo}`;
+      break;
+    }
+    default: {
+      apiPath = `/repos/${repo}`;
+    }
+  }
+  const repoInfo = await apiRequest(apiPath, { token, backend });
+  let defaultBranchName;
+  if (backend === 'bitbucket') {
+    const {
+      mainbranch: { name },
+    } = repoInfo;
+    defaultBranchName = name;
+  } else {
+    const { default_branch } = repoInfo;
+    defaultBranchName = default_branch;
+  }
+  return defaultBranchName;
+}
+
 export async function readFile(
   id: string | null | undefined,
   fetchContent: () => Promise<string | Blob>,

package/src/__tests__/api.spec.js

@@ -1,4 +1,5 @@
 import * as api from '../API';
+
 describe('Api', () => {
   describe('getPreviewStatus', () => {
     it('should return preview status on matching context', () => {

package/src/index.ts

@@ -34,6 +34,7 @@ import {
   getPreviewStatus,
   PreviewState,
   requestWithBackoff,
+  getDefaultBranchName,
   throwOnConflictingBranches,
 } from './API';
 import {
@@ -148,6 +149,7 @@ export const DecapCmsLibUtil = {
   contentKeyFromBranch,
   blobToFileObj,
   requestWithBackoff,
+  getDefaultBranchName,
   allEntriesByFolder,
   AccessTokenError,
   throwOnConflictingBranches,
@@ -204,6 +206,7 @@ export {
   contentKeyFromBranch,
   blobToFileObj,
   requestWithBackoff,
+  getDefaultBranchName,
   allEntriesByFolder,
   AccessTokenError,
   throwOnConflictingBranches,