@sanity/desk-tool/lib/actions/PublishAction.js

Tool for managing all sorts of content in a structured manner

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.PublishAction = void 0;
var _reactHooks = require("@sanity/react-hooks");
var _icons = require("@sanity/icons");
var _react = _interopRequireWildcard(require("react"));
var _hooks = require("@sanity/base/hooks");
var _components = require("@sanity/base/components");
var _TimeAgo = require("../components/TimeAgo");
var _useDocumentPane2 = require("../panes/document/useDocumentPane");
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
var DISABLED_REASON_TITLE = {
  LIVE_EDIT_ENABLED: 'Cannot publish since liveEdit is enabled for this document type',
  ALREADY_PUBLISHED: 'Already published',
  NO_CHANGES: 'No unpublished changes',
  NOT_READY: 'Operation not ready'
};
function getDisabledReason(reason, publishedAt) {
  if (reason === 'ALREADY_PUBLISHED' && publishedAt) {
    return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("span", null, "Published ", /*#__PURE__*/_react.default.createElement(_TimeAgo.TimeAgo, {
      time: publishedAt
    })));
  }
  return DISABLED_REASON_TITLE[reason];
}

// eslint-disable-next-line complexity
var PublishAction = props => {
  var _editState$transactio;
  var id = props.id,
    type = props.type,
    liveEdit = props.liveEdit,
    draft = props.draft,
    published = props.published;
  var _useState = (0, _react.useState)(null),
    _useState2 = _slicedToArray(_useState, 2),
    publishState = _useState2[0],
    setPublishState = _useState2[1];
  var _useDocumentOperation = (0, _reactHooks.useDocumentOperation)(id, type),
    publish = _useDocumentOperation.publish;
  var validationStatus = (0, _reactHooks.useValidationStatus)(id, type);
  var syncState = (0, _reactHooks.useSyncState)(id, type);
  var _useDocumentPane = (0, _useDocumentPane2.useDocumentPane)(),
    changesOpen = _useDocumentPane.changesOpen,
    handleHistoryOpen = _useDocumentPane.handleHistoryOpen,
    documentId = _useDocumentPane.documentId,
    documentType = _useDocumentPane.documentType;
  var editState = (0, _reactHooks.useEditState)(documentId, documentType);
  var revision = ((editState === null || editState === void 0 ? void 0 : editState.draft) || (editState === null || editState === void 0 ? void 0 : editState.published) || {})._rev;
  var hasValidationErrors = validationStatus.markers.some(marker => marker.level === 'error');
  // we use this to "schedule" publish after pending tasks (e.g. validation and sync) has completed
  var _useState3 = (0, _react.useState)(false),
    _useState4 = _slicedToArray(_useState3, 2),
    publishScheduled = _useState4[0],
    setPublishScheduled = _useState4[1];
  var isSyncing = syncState.isSyncing;
  var isValidating = validationStatus.isValidating;
  var _useDocumentPairPermi = (0, _hooks.unstable_useDocumentPairPermissions)({
      id,
      type,
      permission: 'publish'
    }),
    _useDocumentPairPermi2 = _slicedToArray(_useDocumentPairPermi, 2),
    permissions = _useDocumentPairPermi2[0],
    isPermissionsLoading = _useDocumentPairPermi2[1];
  var _useCurrentUser = (0, _hooks.useCurrentUser)(),
    currentUser = _useCurrentUser.value;

  // eslint-disable-next-line no-nested-ternary
  var title = publish.disabled ? getDisabledReason(publish.disabled, (published || {})._updatedAt) || '' : hasValidationErrors ? 'There are validation errors that need to be fixed before this document can be published' : '';
  var hasDraft = Boolean(draft);
  var doPublish = (0, _react.useCallback)(() => {
    publish.execute();
    setPublishState('publishing');
  }, [publish]);
  (0, _react.useEffect)(() => {
    // make sure the validation status is about the current revision and not an earlier one
    var validationComplete = validationStatus.isValidating === false && validationStatus.revision !== revision;
    if (!publishScheduled || isSyncing || !validationComplete) {
      return;
    }
    if (!hasValidationErrors) {
      doPublish();
    }
    setPublishScheduled(false);
  }, [isSyncing, doPublish, hasValidationErrors, publishScheduled, validationStatus.revision, revision, isValidating, validationStatus.isValidating]);
  (0, _react.useEffect)(() => {
    var didPublish = publishState === 'publishing' && !hasDraft;
    if (didPublish) {
      if (changesOpen) {
        // Re-open the panel
        handleHistoryOpen();
      }
    }
    var nextState = didPublish ? 'published' : null;
    var delay = didPublish ? 200 : 4000;
    var timer = setTimeout(() => {
      setPublishState(nextState);
    }, delay);
    return () => clearTimeout(timer);
  }, [changesOpen, publishState, hasDraft, handleHistoryOpen]);
  var handle = (0, _react.useCallback)(() => {
    if (syncState.isSyncing || validationStatus.isValidating || validationStatus.revision !== revision) {
      setPublishScheduled(true);
    } else {
      doPublish();
    }
  }, [syncState.isSyncing, validationStatus.isValidating, validationStatus.revision, revision, doPublish]);
  if (liveEdit) {
    return {
      color: 'success',
      label: 'Publish',
      title: 'Live Edit is enabled for this content type and publishing happens automatically as you make changes',
      disabled: true
    };
  }
  if (!isPermissionsLoading && !(permissions !== null && permissions !== void 0 && permissions.granted)) {
    return {
      color: 'success',
      label: 'Publish',
      title: /*#__PURE__*/_react.default.createElement(_components.InsufficientPermissionsMessage, {
        operationLabel: "publish this document",
        currentUser: currentUser
      }),
      disabled: true
    };
  }
  var disabled = Boolean(publishScheduled || (editState === null || editState === void 0 || (_editState$transactio = editState.transactionSyncLock) === null || _editState$transactio === void 0 ? void 0 : _editState$transactio.enabled) || publishState === 'publishing' || publishState === 'published' || hasValidationErrors || publish.disabled);
  return {
    disabled: disabled || isPermissionsLoading,
    color: 'success',
    label:
    // eslint-disable-next-line no-nested-ternary
    publishState === 'published' ? 'Published' : publishScheduled || publishState === 'publishing' ? 'Publishing…' : 'Publish',
    // @todo: Implement loading state, to show a `<Button loading />` state
    // loading: publishScheduled || publishState === 'publishing',
    icon: publishState === 'published' ? _icons.CheckmarkIcon : _icons.PublishIcon,
    // eslint-disable-next-line no-nested-ternary
    title: publishScheduled ? 'Waiting for tasks to finish before publishing' : publishState === 'published' || publishState === 'publishing' ? null : title,
    shortcut: disabled || publishScheduled ? null : 'Ctrl+Alt+P',
    onHandle: handle
  };
};
exports.PublishAction = PublishAction;