@craftercms/studio-ui/components/PublishingStatusDisplay/utils.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import { PublishingStatus } from '../../models/Publishing';
import { IntlShape } from 'react-intl';
export declare const publishingStatusMessages: {
  ready: {
    id: string;
    defaultMessage: string;
  };
  processing: {
    id: string;
    defaultMessage: string;
  };
  publishing: {
    id: string;
    defaultMessage: string;
  };
  queued: {
    id: string;
    defaultMessage: string;
  };
  stopped: {
    id: string;
    defaultMessage: string;
  };
  error: {
    id: string;
    defaultMessage: string;
  };
  disabled: {
    id: string;
    defaultMessage: string;
  };
  unknown: {
    id: string;
    defaultMessage: string;
  };
  processingMessage: {
    id: string;
    defaultMessage: string;
  };
  publishingMessage: {
    id: string;
    defaultMessage: string;
  };
  queuedMessage: {
    id: string;
    defaultMessage: string;
  };
  stoppedMessage: {
    id: string;
    defaultMessage: string;
  };
  errorMessage: {
    id: string;
    defaultMessage: string;
  };
  refresh: {
    id: string;
    defaultMessage: string;
  };
  unlock: {
    id: string;
    defaultMessage: string;
  };
  start: {
    id: string;
    defaultMessage: string;
  };
  stop: {
    id: string;
    defaultMessage: string;
  };
  publishingStatus: {
    id: string;
    defaultMessage: string;
  };
  lockOwner: {
    id: string;
    defaultMessage: string;
  };
  lockTTL: {
    id: string;
    defaultMessage: string;
  };
  disabledMessage: {
    id: string;
    defaultMessage: string;
  };
  yes: {
    id: string;
    defaultMessage: string;
  };
  no: {
    id: string;
    defaultMessage: string;
  };
  confirmUnlockPublisher: {
    id: string;
    defaultMessage: string;
  };
};
export declare function getPublishingStatusText(
  status: Pick<PublishingStatus, 'status' | 'enabled'>,
  formatMessage: IntlShape['formatMessage']
): string;
export declare function getPublishingStatusMessage(
  props: Pick<
    PublishingStatus,
    'status' | 'numberOfItems' | 'totalItems' | 'publishingTarget' | 'submissionId' | 'enabled'
  >,
  formatMessage: IntlShape['formatMessage']
): string;