@craftercms/studio-ui/state/actions/content.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 QuickCreateItem from '../../models/content/QuickCreateItem';
import { AjaxError } from 'rxjs/ajax';
import { DetailedItem, SandboxItem } from '../../models/Item';
import StandardAction from '../../models/StandardAction';
export declare const fetchQuickCreateList: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<'FETCH_QUICK_CREATE_LIST'>;
export declare const fetchQuickCreateListComplete: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  QuickCreateItem[],
  string
>;
export declare const fetchQuickCreateListFailed: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<'FETCH_QUICK_CREATE_LIST_FAILED'>;
export declare const fetchDetailedItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const reloadDetailedItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const completeDetailedItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    force?: boolean;
  },
  string
>;
export declare const fetchDetailedItemComplete: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  DetailedItem,
  string
>;
export declare const fetchDetailedItemFailed: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  AjaxError,
  string
>;
export declare const fetchDetailedItems: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    paths: string[];
  },
  string
>;
export declare const fetchDetailedItemsComplete: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    items: DetailedItem[];
  },
  string
>;
export declare const fetchDetailedItemsFailed: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  AjaxError,
  string
>;
export type FetchSandboxItemPayload = {
  path: string;
};
export type FetchSandboxItemsPayload = {
  paths: string[];
};
export declare const fetchSandboxItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  FetchSandboxItemPayload,
  string
>;
export declare const fetchSandboxItems: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  FetchSandboxItemsPayload,
  string
>;
export type FetchSandboxItemCompletePayload = {
  item: SandboxItem;
};
export type FetchSandboxItemsCompletePayload = {
  items: SandboxItem[];
};
export declare const fetchSandboxItemComplete: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  FetchSandboxItemCompletePayload,
  string
>;
export declare const fetchSandboxItemsComplete: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  FetchSandboxItemsCompletePayload,
  string
>;
export declare const fetchSandboxItemFailed: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  AjaxError,
  string
>;
export declare const fetchSandboxItemsFailed: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  AjaxError,
  string
>;
export declare const sandboxItemsMissing: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    paths: string[];
  },
  string
>;
export declare const updateItemsByPath: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    items: SandboxItem[];
  },
  string
>;
export declare const setClipboard: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    type: 'CUT' | 'COPY';
    paths?: string[];
    sourcePath: string;
  },
  string
>;
export declare const restoreClipboard: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    type: 'CUT' | 'COPY';
    paths?: string[];
    sourcePath: string;
  },
  string
>;
export declare const clearClipboard: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<'CLEAR_CLIPBOARD'>;
export declare const duplicateItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    onSuccess: StandardAction;
  },
  string
>;
export declare const duplicateAsset: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    onSuccess: StandardAction;
  },
  string
>;
export declare const duplicateWithPolicyValidation: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    type: 'item' | 'asset';
  },
  string
>;
export declare const pasteItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const pasteItemWithPolicyValidation: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const unlockItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    notify?: boolean;
  },
  string
>;
export declare const unlockItemCompleted: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const unlockItemFailed: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<'LOCK_ITEM_FAILED'>;
export declare const lockItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
  },
  string
>;
export declare const lockItemCompleted: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    username: string;
  },
  string
>;
export declare const lockItemFailed: import('@reduxjs/toolkit').ActionCreatorWithoutPayload<'LOCK_ITEM_FAILED'>;
export declare const conditionallyUnlockItem: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    path: string;
    notify?: boolean;
  },
  string
>;
export declare const deleteController: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    item: DetailedItem;
    onSuccess?: StandardAction;
  },
  string
>;
export declare const deleteTemplate: import('@reduxjs/toolkit').ActionCreatorWithOptionalPayload<
  {
    item: DetailedItem;
    onSuccess?: StandardAction;
  },
  string
>;