"use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.default = void 0; var React = _interopRequireWildcard(require("react")); var _semaphore = _interopRequireDefault(require("semaphore")); var _trimStart = _interopRequireDefault(require("lodash/trimStart")); var _commonTags = require("common-tags"); var _decapCmsLibUtil = require("decap-cms-lib-util"); var _AuthenticationPage = _interopRequireDefault(require("./AuthenticationPage")); var _API = _interopRequireWildcard(require("./API")); var _GraphQLAPI = _interopRequireDefault(require("./GraphQLAPI")); var _react2 = require("@emotion/react"); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); } function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; } function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); } 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(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; const { fetchWithTimeout: fetch } = _decapCmsLibUtil.unsentRequest; const STATUS_PAGE = 'https://www.githubstatus.com'; const GITHUB_STATUS_ENDPOINT = `${STATUS_PAGE}/api/v2/components.json`; const GITHUB_OPERATIONAL_UNITS = ['API Requests', 'Issues, Pull Requests, Projects']; class GitHub { constructor(config, options = {}) { var _config$backend$branc; _defineProperty(this, "lock", void 0); _defineProperty(this, "api", void 0); _defineProperty(this, "options", void 0); _defineProperty(this, "originRepo", void 0); _defineProperty(this, "isBranchConfigured", void 0); _defineProperty(this, "repo", void 0); _defineProperty(this, "openAuthoringEnabled", void 0); _defineProperty(this, "useOpenAuthoring", void 0); _defineProperty(this, "alwaysForkEnabled", void 0); _defineProperty(this, "branch", void 0); _defineProperty(this, "apiRoot", void 0); _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); _defineProperty(this, "getCursorAndFiles", (files, page) => { const pageSize = 20; const count = files.length; const pageCount = Math.ceil(files.length / pageSize); const actions = []; if (page > 1) { actions.push('prev'); actions.push('first'); } if (page < pageCount) { actions.push('next'); actions.push('last'); } const cursor = _decapCmsLibUtil.Cursor.create({ actions, meta: { page, count, pageSize, pageCount }, data: { files } }); const pageFiles = files.slice((page - 1) * pageSize, page * pageSize); return { cursor, files: pageFiles }; }); this.options = _objectSpread({ proxied: false, API: null, initialWorkflowStatus: '' }, options); if (!this.options.proxied && (config.backend.repo === null || config.backend.repo === undefined)) { throw new Error('The GitHub backend needs a "repo" in the backend configuration.'); } this.api = this.options.API || null; this.isBranchConfigured = config.backend.branch ? true : false; this.openAuthoringEnabled = config.backend.open_authoring || false; if (this.openAuthoringEnabled) { if (!this.options.useWorkflow) { throw new Error('backend.open_authoring is true but publish_mode is not set to editorial_workflow.'); } this.originRepo = config.backend.repo || ''; } else { this.repo = this.originRepo = config.backend.repo || ''; } this.alwaysForkEnabled = config.backend.always_fork || false; 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; this.mediaFolder = config.media_folder; this.previewContext = config.backend.preview_context || ''; this.lock = (0, _decapCmsLibUtil.asyncLock)(); } isGitBackend() { return true; } async status() { const api = await fetch(GITHUB_STATUS_ENDPOINT).then(res => res.json()).then(res => { return res['components'].filter(statusComponent => GITHUB_OPERATIONAL_UNITS.includes(statusComponent.name)).every(statusComponent => statusComponent.status === 'operational'); }).catch(e => { console.warn('Failed getting GitHub status', e); return true; }); let auth = false; // no need to check auth if api is down if (api) { 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; } return { auth: { status: auth }, api: { status: api, statusPage: STATUS_PAGE } }; } authComponent() { const wrappedAuthenticationPage = props => (0, _react2.jsx)(_AuthenticationPage.default, _extends({}, props, { backend: this })); wrappedAuthenticationPage.displayName = 'AuthenticationPage'; return wrappedAuthenticationPage; } restoreUser(user) { return this.openAuthoringEnabled ? this.authenticateWithFork({ userData: user, getPermissionToFork: () => true }).then(() => this.authenticate(user)) : this.authenticate(user); } async pollUntilForkExists({ repo, token }) { const pollDelay = 250; // milliseconds let repoExists = false; while (!repoExists) { repoExists = await fetch(`${this.apiRoot}/repos/${repo}`, { headers: { Authorization: `${this.tokenKeyword} ${token}` } }).then(() => true).catch(err => { if (err && err.status === 404) { console.log('This 404 was expected and handled appropriately.'); return false; } else { return Promise.reject(err); } }); // wait between polls if (!repoExists) { await new Promise(resolve => setTimeout(resolve, pollDelay)); } } return Promise.resolve(); } async currentUser({ token }) { if (!this._currentUserPromise) { this._currentUserPromise = fetch(`${this.apiRoot}/user`, { headers: { Authorization: `${this.tokenKeyword} ${token}` } }).then(res => res.json()); } return this._currentUserPromise; } async userIsOriginMaintainer({ username: usernameArg, token }) { const username = usernameArg || (await this.currentUser({ token })).login; this._userIsOriginMaintainerPromises = this._userIsOriginMaintainerPromises || {}; if (!this._userIsOriginMaintainerPromises[username]) { this._userIsOriginMaintainerPromises[username] = fetch(`${this.apiRoot}/repos/${this.originRepo}/collaborators/${username}/permission`, { headers: { Authorization: `${this.tokenKeyword} ${token}` } }).then(res => res.json()).then(({ permission }) => permission === 'admin' || permission === 'write'); } return this._userIsOriginMaintainerPromises[username]; } async forkExists({ token }) { try { const currentUser = await this.currentUser({ token }); const repoName = this.originRepo.split('/')[1]; const repo = await fetch(`${this.apiRoot}/repos/${currentUser.login}/${repoName}`, { method: 'GET', headers: { Authorization: `${this.tokenKeyword} ${token}` } }).then(res => res.json()); // https://developer.github.com/v3/repos/#get // The parent and source objects are present when the repository is a fork. // parent is the repository this repository was forked from, source is the ultimate source for the network. const forkExists = repo.fork === true && repo.parent && repo.parent.full_name.toLowerCase() === this.originRepo.toLowerCase(); return forkExists; } catch { return false; } } async authenticateWithFork({ userData, getPermissionToFork }) { if (!this.openAuthoringEnabled) { throw new Error('Cannot authenticate with fork; Open Authoring is turned off.'); } const token = userData.token; // Origin maintainers should be able to use the CMS normally. If alwaysFork // is enabled we always fork (and avoid the origin maintainer check) if (!this.alwaysForkEnabled && (await this.userIsOriginMaintainer({ token }))) { this.repo = this.originRepo; this.useOpenAuthoring = false; return Promise.resolve(); } // 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: `${this.tokenKeyword} ${token}` } }).then(res => res.json()); return this.pollUntilForkExists({ repo: fork.full_name, token }); } } async authenticate(state) { this.token = state.token; // Query the default branch name when the `branch` property is missing // in the config file if (!this.isBranchConfigured) { const repoInfo = await fetch(`${this.apiRoot}/repos/${this.originRepo}`, { headers: { Authorization: `token ${this.token}` } }).then(res => res.json()).catch(() => null); if (repoInfo && repoInfo.default_branch) { this.branch = repoInfo.default_branch; } } 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, apiRoot: this.apiRoot, squashMerges: this.squashMerges, 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 => { error.message = (0, _commonTags.stripIndent)` Repo "${this.repo}" not found. Please ensure the repo information is spelled correctly. If the repo is private, make sure you're logged into a GitHub account with access. If your repo is under an organization, ensure the organization has granted access to Decap CMS. `; throw error; }); // Unauthorized user if (!isCollab && !this.bypassWriteAccessCheckForAppTokens) { throw new Error('Your GitHub user account does not have access to this repo.'); } // if (!this.isBranchConfigured) { // const defaultBranchName = await this.api.getDefaultBranchName() // if (defaultBranchName) { // this.branch = defaultBranchName; // } // } // Authorized user return _objectSpread(_objectSpread({}, user), {}, { token: state.token, useOpenAuthoring: this.useOpenAuthoring }); } logout() { this.token = null; if (this.api && this.api.reset && typeof this.api.reset === 'function') { return this.api.reset(); } } getToken() { return Promise.resolve(this.token); } async entriesByFolder(folder, extension, depth) { const repoURL = this.api.originRepoURL; let cursor; const listFiles = () => this.api.listFiles(folder, { repoURL, depth }).then(files => { const filtered = files.filter(file => (0, _decapCmsLibUtil.filterByExtension)(file, extension)); const result = this.getCursorAndFiles(filtered, 1); cursor = result.cursor; return result.files; }); const readFile = (path, id) => this.api.readFile(path, id, { repoURL }); const files = await (0, _decapCmsLibUtil.entriesByFolder)(listFiles, readFile, this.api.readFileMetadata.bind(this.api), _API.API_NAME); // eslint-disable-next-line @typescript-eslint/ban-ts-comment // @ts-ignore files[_decapCmsLibUtil.CURSOR_COMPATIBILITY_SYMBOL] = cursor; return files; } async allEntriesByFolder(folder, extension, depth, pathRegex) { const repoURL = this.api.originRepoURL; const listFiles = () => this.api.listFiles(folder, { repoURL, depth }).then(files => files.filter(file => (!pathRegex || pathRegex.test(file.path)) && (0, _decapCmsLibUtil.filterByExtension)(file, extension))); const readFile = (path, id) => { return this.api.readFile(path, id, { repoURL }); }; const files = await (0, _decapCmsLibUtil.entriesByFolder)(listFiles, readFile, this.api.readFileMetadata.bind(this.api), _API.API_NAME); return files; } entriesByFiles(files) { const repoURL = this.useOpenAuthoring ? this.api.originRepoURL : this.api.repoURL; const readFile = (path, id) => this.api.readFile(path, id, { repoURL }).catch(() => ''); return (0, _decapCmsLibUtil.entriesByFiles)(files, readFile, this.api.readFileMetadata.bind(this.api), _API.API_NAME); } // Fetches a single entry. getEntry(path) { const repoURL = this.api.originRepoURL; return this.api.readFile(path, null, { repoURL }).then(data => ({ file: { path, id: null }, data: data })).catch(() => ({ file: { path, id: null }, data: '' })); } getMedia(mediaFolder = this.mediaFolder) { return this.api.listFiles(mediaFolder).then(files => files.map(({ id, name, size, path }) => { // load media using getMediaDisplayURL to avoid token expiration with GitHub raw content urls // for private repositories return { id, name, size, displayURL: { id, path }, path }; })); } async getMediaFile(path) { const blob = await (0, _decapCmsLibUtil.getMediaAsBlob)(path, null, this.api.readFile.bind(this.api)); const name = (0, _decapCmsLibUtil.basename)(path); const fileObj = (0, _decapCmsLibUtil.blobToFileObj)(name, blob); const url = URL.createObjectURL(fileObj); const id = await (0, _decapCmsLibUtil.getBlobSHA)(blob); return { id, displayURL: url, path, name, size: fileObj.size, file: fileObj, url }; } getMediaDisplayURL(displayURL) { this._mediaDisplayURLSem = this._mediaDisplayURLSem || (0, _semaphore.default)(MAX_CONCURRENT_DOWNLOADS); return (0, _decapCmsLibUtil.getMediaDisplayURL)(displayURL, this.api.readFile.bind(this.api), this._mediaDisplayURLSem); } persistEntry(entry, options) { // persistEntry is a transactional operation return (0, _decapCmsLibUtil.runWithLock)(this.lock, () => this.api.persistFiles(entry.dataFiles, entry.assets, options), 'Failed to acquire persist entry lock'); } async persistMedia(mediaFile, options) { try { await this.api.persistFiles([], [mediaFile], options); const { sha, path, fileObj } = mediaFile; const displayURL = fileObj ? URL.createObjectURL(fileObj) : ''; return { id: sha, name: fileObj.name, size: fileObj.size, displayURL, path: (0, _trimStart.default)(path, '/') }; } catch (error) { console.error(error); throw error; } } deleteFiles(paths, commitMessage) { return this.api.deleteFiles(paths, commitMessage); } async traverseCursor(cursor, action) { const meta = cursor.meta; const files = cursor.data.get('files').toJS(); let result; switch (action) { case 'first': { result = this.getCursorAndFiles(files, 1); break; } case 'last': { result = this.getCursorAndFiles(files, meta.get('pageCount')); break; } case 'next': { result = this.getCursorAndFiles(files, meta.get('page') + 1); break; } case 'prev': { result = this.getCursorAndFiles(files, meta.get('page') - 1); break; } default: { result = this.getCursorAndFiles(files, 1); break; } } const readFile = (path, id) => this.api.readFile(path, id, { repoURL: this.api.originRepoURL }).catch(() => ''); const entries = await (0, _decapCmsLibUtil.entriesByFiles)(result.files, readFile, this.api.readFileMetadata.bind(this.api), _API.API_NAME); return { entries, cursor: result.cursor }; } async loadMediaFile(branch, file) { const readFile = (path, id, { parseText }) => this.api.readFile(path, id, { branch, parseText }); const blob = await (0, _decapCmsLibUtil.getMediaAsBlob)(file.path, file.id, readFile); const name = (0, _decapCmsLibUtil.basename)(file.path); const fileObj = (0, _decapCmsLibUtil.blobToFileObj)(name, blob); return { id: file.id, displayURL: URL.createObjectURL(fileObj), path: file.path, name, size: fileObj.size, file: fileObj }; } async unpublishedEntries() { const listEntriesKeys = () => this.api.listUnpublishedBranches().then(branches => branches.map(branch => (0, _decapCmsLibUtil.contentKeyFromBranch)(branch))); const ids = await (0, _decapCmsLibUtil.unpublishedEntries)(listEntriesKeys); return ids; } async unpublishedEntry({ id, collection, slug }) { if (id) { const data = await this.api.retrieveUnpublishedEntryData(id); return data; } else if (collection && slug) { const entryId = this.api.generateContentKey(collection, slug); const data = await this.api.retrieveUnpublishedEntryData(entryId); return data; } else { throw new Error('Missing unpublished entry id or collection and slug'); } } getBranch(collection, slug) { const contentKey = this.api.generateContentKey(collection, slug); const branch = (0, _decapCmsLibUtil.branchFromContentKey)(contentKey); return branch; } async unpublishedEntryDataFile(collection, slug, path, id) { const branch = this.getBranch(collection, slug); const data = await this.api.readFile(path, id, { branch }); return data; } async unpublishedEntryMediaFile(collection, slug, path, id) { const branch = this.getBranch(collection, slug); const mediaFile = await this.loadMediaFile(branch, { path, id }); return mediaFile; } async getDeployPreview(collection, slug) { try { const statuses = await this.api.getStatuses(collection, slug); const deployStatus = (0, _decapCmsLibUtil.getPreviewStatus)(statuses, this.previewContext); if (deployStatus) { const { target_url: url, state } = deployStatus; return { url, status: state }; } else { return null; } } catch (e) { return null; } } updateUnpublishedEntryStatus(collection, slug, newStatus) { // updateUnpublishedEntryStatus is a transactional operation return (0, _decapCmsLibUtil.runWithLock)(this.lock, () => this.api.updateUnpublishedEntryStatus(collection, slug, newStatus), 'Failed to acquire update entry status lock'); } deleteUnpublishedEntry(collection, slug) { // deleteUnpublishedEntry is a transactional operation return (0, _decapCmsLibUtil.runWithLock)(this.lock, () => this.api.deleteUnpublishedEntry(collection, slug), 'Failed to acquire delete entry lock'); } publishUnpublishedEntry(collection, slug) { // publishUnpublishedEntry is a transactional operation return (0, _decapCmsLibUtil.runWithLock)(this.lock, () => this.api.publishUnpublishedEntry(collection, slug), 'Failed to acquire publish entry lock'); } } exports.default = GitHub;