decap-cms-backend-github 3.1.0-beta.0 → 3.1.0-beta.2

package/dist/esm/API.js

@@ -77,6 +77,7 @@ class API {
   constructor(config) {
     _defineProperty(this, "apiRoot", void 0);
     _defineProperty(this, "token", void 0);
+    _defineProperty(this, "tokenKeyword", void 0);
     _defineProperty(this, "branch", void 0);
     _defineProperty(this, "useOpenAuthoring", void 0);
     _defineProperty(this, "repo", void 0);
@@ -90,6 +91,8 @@ class API {
     _defineProperty(this, "mergeMethod", void 0);
     _defineProperty(this, "initialWorkflowStatus", void 0);
     _defineProperty(this, "cmsLabelPrefix", void 0);
+    _defineProperty(this, "baseUrl", void 0);
+    _defineProperty(this, "getUser", void 0);
     _defineProperty(this, "_userPromise", void 0);
     _defineProperty(this, "_metadataSemaphore", void 0);
     _defineProperty(this, "commitAuthor", void 0);
@@ -122,6 +125,7 @@ class API {
     });
     this.apiRoot = config.apiRoot || 'https://api.github.com';
     this.token = config.token || '';
+    this.tokenKeyword = config.tokenKeyword || 'token';
     this.branch = config.branch || 'master';
     this.useOpenAuthoring = config.useOpenAuthoring;
     this.repo = config.repo || '';
@@ -137,16 +141,17 @@ class API {
     this.mergeMethod = config.squashMerges ? 'squash' : 'merge';
     this.cmsLabelPrefix = config.cmsLabelPrefix;
     this.initialWorkflowStatus = config.initialWorkflowStatus;
+    this.baseUrl = config.baseUrl;
+    this.getUser = config.getUser;
   }
   user() {
     if (!this._userPromise) {
-      this._userPromise = this.getUser();
+      this._userPromise = this.getUser({
+        token: this.token
+      });
     }
     return this._userPromise;
   }
-  getUser() {
-    return this.request('/user');
-  }
   async hasWriteAccess() {
     try {
       const result = await this.request(this.repoURL);
@@ -166,7 +171,7 @@ class API {
       'Content-Type': 'application/json; charset=utf-8'
     }, headers);
     if (this.token) {
-      baseHeader.Authorization = `token ${this.token}`;
+      baseHeader.Authorization = `${this.tokenKeyword} ${this.token}`;
       return Promise.resolve(baseHeader);
     }
     return Promise.resolve(baseHeader);
@@ -444,7 +449,7 @@ class API {
       return;
     }
     try {
-      const user = await this.request(`/users/${pullRequest.user.login}`);
+      const user = await this.user();
       return user.name || user.login;
     } catch {
       return;

package/dist/esm/GraphQLAPI.js

@@ -58,7 +58,7 @@ class GraphQLAPI extends _API.default {
         headers: _objectSpread(_objectSpread({
           'Content-Type': 'application/json; charset=utf-8'
         }, headers), {}, {
-          authorization: this.token ? `token ${this.token}` : ''
+          authorization: this.token ? `${this.tokenKeyword} ${this.token}` : ''
         })
       };
     });

package/dist/esm/implementation.js

@@ -45,9 +45,12 @@ class GitHub {
     _defineProperty(this, "mediaFolder", void 0);
     _defineProperty(this, "previewContext", void 0);
     _defineProperty(this, "token", void 0);
+    _defineProperty(this, "tokenKeyword", void 0);
     _defineProperty(this, "squashMerges", void 0);
     _defineProperty(this, "cmsLabelPrefix", void 0);
     _defineProperty(this, "useGraphql", void 0);
+    _defineProperty(this, "baseUrl", void 0);
+    _defineProperty(this, "bypassWriteAccessCheckForAppTokens", false);
     _defineProperty(this, "_currentUserPromise", void 0);
     _defineProperty(this, "_userIsOriginMaintainerPromises", void 0);
     _defineProperty(this, "_mediaDisplayURLSem", void 0);
@@ -104,6 +107,8 @@ class GitHub {
     this.branch = ((_config$backend$branc = config.backend.branch) === null || _config$backend$branc === void 0 ? void 0 : _config$backend$branc.trim()) || 'master';
     this.apiRoot = config.backend.api_root || 'https://api.github.com';
     this.token = '';
+    this.tokenKeyword = 'token';
+    this.baseUrl = config.backend.base_url;
     this.squashMerges = config.backend.squash_merges || false;
     this.cmsLabelPrefix = config.backend.cms_label_prefix || '';
     this.useGraphql = config.backend.use_graphql || false;
@@ -124,8 +129,10 @@ class GitHub {
     let auth = false;
     // no need to check auth if api is down
     if (api) {
-      var _this$api;
-      auth = (await ((_this$api = this.api) === null || _this$api === void 0 ? void 0 : _this$api.getUser().then(user => !!user).catch(e => {
+      var _this$api, _this$token;
+      auth = (await ((_this$api = this.api) === null || _this$api === void 0 ? void 0 : _this$api.getUser({
+        token: (_this$token = this.token) !== null && _this$token !== void 0 ? _this$token : ''
+      }).then(user => !!user).catch(e => {
         console.warn('Failed getting GitHub user', e);
         return false;
       }))) || false;
@@ -162,7 +169,7 @@ class GitHub {
     while (!repoExists) {
       repoExists = await fetch(`${this.apiRoot}/repos/${repo}`, {
         headers: {
-          Authorization: `token ${token}`
+          Authorization: `${this.tokenKeyword} ${token}`
         }
       }).then(() => true).catch(err => {
         if (err && err.status === 404) {
@@ -185,7 +192,7 @@ class GitHub {
     if (!this._currentUserPromise) {
       this._currentUserPromise = fetch(`${this.apiRoot}/user`, {
         headers: {
-          Authorization: `token ${token}`
+          Authorization: `${this.tokenKeyword} ${token}`
         }
       }).then(res => res.json());
     }
@@ -202,7 +209,7 @@ class GitHub {
     if (!this._userIsOriginMaintainerPromises[username]) {
       this._userIsOriginMaintainerPromises[username] = fetch(`${this.apiRoot}/repos/${this.originRepo}/collaborators/${username}/permission`, {
         headers: {
-          Authorization: `token ${token}`
+          Authorization: `${this.tokenKeyword} ${token}`
         }
       }).then(res => res.json()).then(({
         permission
@@ -221,7 +228,7 @@ class GitHub {
       const repo = await fetch(`${this.apiRoot}/repos/${currentUser.login}/${repoName}`, {
         method: 'GET',
         headers: {
-          Authorization: `token ${token}`
+          Authorization: `${this.tokenKeyword} ${token}`
         }
       }).then(res => res.json());
 
@@ -252,29 +259,47 @@ class GitHub {
       this.useOpenAuthoring = false;
       return Promise.resolve();
     }
-    if (!(await this.forkExists({
+
+    // If a fork exists merge it with upstream
+    // otherwise create a new fork.
+    const currentUser = await this.currentUser({
       token
-    }))) {
-      await getPermissionToFork();
-    }
-    const fork = await fetch(`${this.apiRoot}/repos/${this.originRepo}/forks`, {
-      method: 'POST',
-      headers: {
-        Authorization: `token ${token}`
-      }
-    }).then(res => res.json());
+    });
+    const repoName = this.originRepo.split('/')[1];
+    this.repo = `${currentUser.login}/${repoName}`;
     this.useOpenAuthoring = true;
-    this.repo = fork.full_name;
-    return this.pollUntilForkExists({
-      repo: fork.full_name,
+    if (await this.forkExists({
       token
-    });
+    })) {
+      return fetch(`${this.apiRoot}/repos/${this.repo}/merge-upstream`, {
+        method: 'POST',
+        headers: {
+          Authorization: `${this.tokenKeyword} ${token}`
+        },
+        body: JSON.stringify({
+          branch: this.branch
+        })
+      });
+    } else {
+      await getPermissionToFork();
+      const fork = await fetch(`${this.apiRoot}/repos/${this.originRepo}/forks`, {
+        method: 'POST',
+        headers: {
+          Authorization: `${this.tokenKeyword} ${token}`
+        }
+      }).then(res => res.json());
+      return this.pollUntilForkExists({
+        repo: fork.full_name,
+        token
+      });
+    }
   }
   async authenticate(state) {
     this.token = state.token;
     const apiCtor = this.useGraphql ? _GraphQLAPI.default : _API.default;
     this.api = new apiCtor({
       token: this.token,
+      tokenKeyword: this.tokenKeyword,
       branch: this.branch,
       repo: this.repo,
       originRepo: this.originRepo,
@@ -282,7 +307,9 @@ class GitHub {
       squashMerges: this.squashMerges,
       cmsLabelPrefix: this.cmsLabelPrefix,
       useOpenAuthoring: this.useOpenAuthoring,
-      initialWorkflowStatus: this.options.initialWorkflowStatus
+      initialWorkflowStatus: this.options.initialWorkflowStatus,
+      baseUrl: this.baseUrl,
+      getUser: this.currentUser
     });
     const user = await this.api.user();
     const isCollab = await this.api.hasWriteAccess().catch(error => {
@@ -299,7 +326,7 @@ class GitHub {
     });
 
     // Unauthorized user
-    if (!isCollab) {
+    if (!isCollab && !this.bypassWriteAccessCheckForAppTokens) {
       throw new Error('Your GitHub user account does not have access to this repo.');
     }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "decap-cms-backend-github",
   "description": "GitHub backend for Decap CMS",
-  "version": "3.1.0-beta.0",
+  "version": "3.1.0-beta.2",
   "license": "MIT",
   "repository": "https://github.com/decaporg/decap-cms/tree/master/packages/decap-cms-backend-github",
   "bugs": "https://github.com/decaporg/decap-cms/issues",
@@ -14,7 +14,7 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "develop": "yarn build:esm --watch",
+    "develop": "npm run build:esm -- --watch",
     "build": "cross-env NODE_ENV=production webpack",
     "build:esm": "cross-env NODE_ENV=esm babel src --out-dir dist/esm --ignore \"**/__tests__\" --root-mode upward --extensions \".js,.jsx,.ts,.tsx\"",
     "createFragmentTypes": "node scripts/createFragmentTypes.js"
@@ -40,5 +40,5 @@
     "prop-types": "^15.7.2",
     "react": "^18.2.0"
   },
-  "gitHead": "26f650bbfd8b20611ad9bb8957ce2d889a1a9085"
+  "gitHead": "d7a43e3bb45259ab0789362ea804df31fec77e21"
 }

package/src/API.ts

@@ -50,6 +50,7 @@ export const MOCK_PULL_REQUEST = -1;
 export interface Config {
   apiRoot?: string;
   token?: string;
+  tokenKeyword?: string;
   branch?: string;
   useOpenAuthoring?: boolean;
   repo?: string;
@@ -57,6 +58,8 @@ export interface Config {
   squashMerges: boolean;
   initialWorkflowStatus: string;
   cmsLabelPrefix: string;
+  baseUrl?: string;
+  getUser: ({ token }: { token: string }) => Promise<GitHubUser>;
 }
 
 interface TreeFile {
@@ -173,6 +176,7 @@ let migrationNotified = false;
 export default class API {
   apiRoot: string;
   token: string;
+  tokenKeyword: string;
   branch: string;
   useOpenAuthoring?: boolean;
   repo: string;
@@ -186,7 +190,8 @@ export default class API {
   mergeMethod: string;
   initialWorkflowStatus: string;
   cmsLabelPrefix: string;
-
+  baseUrl?: string;
+  getUser: ({ token }: { token: string }) => Promise<GitHubUser>;
   _userPromise?: Promise<GitHubUser>;
   _metadataSemaphore?: Semaphore;
 
@@ -195,6 +200,7 @@ export default class API {
   constructor(config: Config) {
     this.apiRoot = config.apiRoot || 'https://api.github.com';
     this.token = config.token || '';
+    this.tokenKeyword = config.tokenKeyword || 'token';
     this.branch = config.branch || 'master';
     this.useOpenAuthoring = config.useOpenAuthoring;
     this.repo = config.repo || '';
@@ -213,21 +219,19 @@ export default class API {
     this.mergeMethod = config.squashMerges ? 'squash' : 'merge';
     this.cmsLabelPrefix = config.cmsLabelPrefix;
     this.initialWorkflowStatus = config.initialWorkflowStatus;
+    this.baseUrl = config.baseUrl;
+    this.getUser = config.getUser;
   }
 
   static DEFAULT_COMMIT_MESSAGE = 'Automatically generated by Decap CMS';
 
   user(): Promise<{ name: string; login: string }> {
     if (!this._userPromise) {
-      this._userPromise = this.getUser();
+      this._userPromise = this.getUser({ token: this.token });
     }
     return this._userPromise;
   }
 
-  getUser() {
-    return this.request('/user') as Promise<GitHubUser>;
-  }
-
   async hasWriteAccess() {
     try {
       const result: Octokit.ReposGetResponse = await this.request(this.repoURL);
@@ -251,7 +255,7 @@ export default class API {
     };
 
     if (this.token) {
-      baseHeader.Authorization = `token ${this.token}`;
+      baseHeader.Authorization = `${this.tokenKeyword} ${this.token}`;
       return Promise.resolve(baseHeader);
     }
 
@@ -576,7 +580,7 @@ export default class API {
     }
 
     try {
-      const user: GitHubUser = await this.request(`/users/${pullRequest.user.login}`);
+      const user = await this.user();
       return user.name || user.login;
     } catch {
       return;

package/src/GraphQLAPI.ts

@@ -108,7 +108,7 @@ export default class GraphQLAPI extends API {
         headers: {
           'Content-Type': 'application/json; charset=utf-8',
           ...headers,
-          authorization: this.token ? `token ${this.token}` : '',
+          authorization: this.token ? `${this.tokenKeyword} ${this.token}` : '',
         },
       };
     });

package/src/implementation.tsx

@@ -42,7 +42,7 @@ import type {
 } from 'decap-cms-lib-util';
 import type { Semaphore } from 'semaphore';
 
-type GitHubUser = Octokit.UsersGetAuthenticatedResponse;
+export type GitHubUser = Octokit.UsersGetAuthenticatedResponse;
 
 const MAX_CONCURRENT_DOWNLOADS = 10;
 
@@ -78,9 +78,12 @@ export default class GitHub implements Implementation {
   mediaFolder: string;
   previewContext: string;
   token: string | null;
+  tokenKeyword: string;
   squashMerges: boolean;
   cmsLabelPrefix: string;
   useGraphql: boolean;
+  baseUrl?: string;
+  bypassWriteAccessCheckForAppTokens = false;
   _currentUserPromise?: Promise<GitHubUser>;
   _userIsOriginMaintainerPromises?: {
     [key: string]: Promise<boolean>;
@@ -119,6 +122,8 @@ export default class GitHub implements Implementation {
     this.branch = config.backend.branch?.trim() || 'master';
     this.apiRoot = config.backend.api_root || 'https://api.github.com';
     this.token = '';
+    this.tokenKeyword = 'token';
+    this.baseUrl = config.backend.base_url;
     this.squashMerges = config.backend.squash_merges || false;
     this.cmsLabelPrefix = config.backend.cms_label_prefix || '';
     this.useGraphql = config.backend.use_graphql || false;
@@ -153,7 +158,7 @@ export default class GitHub implements Implementation {
     if (api) {
       auth =
         (await this.api
-          ?.getUser()
+          ?.getUser({ token: this.token ?? '' })
           .then(user => !!user)
           .catch(e => {
             console.warn('Failed getting GitHub user', e);
@@ -185,7 +190,7 @@ export default class GitHub implements Implementation {
     let repoExists = false;
     while (!repoExists) {
       repoExists = await fetch(`${this.apiRoot}/repos/${repo}`, {
-        headers: { Authorization: `token ${token}` },
+        headers: { Authorization: `${this.tokenKeyword} ${token}` },
       })
         .then(() => true)
         .catch(err => {
@@ -208,7 +213,7 @@ export default class GitHub implements Implementation {
     if (!this._currentUserPromise) {
       this._currentUserPromise = fetch(`${this.apiRoot}/user`, {
         headers: {
-          Authorization: `token ${token}`,
+          Authorization: `${this.tokenKeyword} ${token}`,
         },
       }).then(res => res.json());
     }
@@ -229,7 +234,7 @@ export default class GitHub implements Implementation {
         `${this.apiRoot}/repos/${this.originRepo}/collaborators/${username}/permission`,
         {
           headers: {
-            Authorization: `token ${token}`,
+            Authorization: `${this.tokenKeyword} ${token}`,
           },
         },
       )
@@ -246,7 +251,7 @@ export default class GitHub implements Implementation {
       const repo = await fetch(`${this.apiRoot}/repos/${currentUser.login}/${repoName}`, {
         method: 'GET',
         headers: {
-          Authorization: `token ${token}`,
+          Authorization: `${this.tokenKeyword} ${token}`,
         },
       }).then(res => res.json());
 
@@ -283,19 +288,34 @@ export default class GitHub implements Implementation {
       return Promise.resolve();
     }
 
-    if (!(await this.forkExists({ token }))) {
+    // If a fork exists merge it with upstream
+    // otherwise create a new fork.
+    const currentUser = await this.currentUser({ token });
+    const repoName = this.originRepo.split('/')[1];
+    this.repo = `${currentUser.login}/${repoName}`;
+    this.useOpenAuthoring = true;
+
+    if (await this.forkExists({ token })) {
+      return fetch(`${this.apiRoot}/repos/${this.repo}/merge-upstream`, {
+        method: 'POST',
+        headers: {
+          Authorization: `${this.tokenKeyword} ${token}`,
+        },
+        body: JSON.stringify({
+          branch: this.branch,
+        }),
+      });
+    } else {
       await getPermissionToFork();
-    }
 
-    const fork = await fetch(`${this.apiRoot}/repos/${this.originRepo}/forks`, {
-      method: 'POST',
-      headers: {
-        Authorization: `token ${token}`,
-      },
-    }).then(res => res.json());
-    this.useOpenAuthoring = true;
-    this.repo = fork.full_name;
-    return this.pollUntilForkExists({ repo: fork.full_name, token });
+      const fork = await fetch(`${this.apiRoot}/repos/${this.originRepo}/forks`, {
+        method: 'POST',
+        headers: {
+          Authorization: `${this.tokenKeyword} ${token}`,
+        },
+      }).then(res => res.json());
+      return this.pollUntilForkExists({ repo: fork.full_name, token });
+    }
   }
 
   async authenticate(state: Credentials) {
@@ -303,6 +323,7 @@ export default class GitHub implements Implementation {
     const apiCtor = this.useGraphql ? GraphQLAPI : API;
     this.api = new apiCtor({
       token: this.token,
+      tokenKeyword: this.tokenKeyword,
       branch: this.branch,
       repo: this.repo,
       originRepo: this.originRepo,
@@ -311,6 +332,8 @@ export default class GitHub implements Implementation {
       cmsLabelPrefix: this.cmsLabelPrefix,
       useOpenAuthoring: this.useOpenAuthoring,
       initialWorkflowStatus: this.options.initialWorkflowStatus,
+      baseUrl: this.baseUrl,
+      getUser: this.currentUser,
     });
     const user = await this.api!.user();
     const isCollab = await this.api!.hasWriteAccess().catch(error => {
@@ -327,7 +350,7 @@ export default class GitHub implements Implementation {
     });
 
     // Unauthorized user
-    if (!isCollab) {
+    if (!isCollab && !this.bypassWriteAccessCheckForAppTokens) {
       throw new Error('Your GitHub user account does not have access to this repo.');
     }