@craftercms/studio-ui/services/sites.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 { Action, ContentValidationResult, CreateSiteMeta, LegacySite, Site } from '../models/Site';
import { Observable } from 'rxjs';
import { PagedArray } from '../models/PagedArray';
import { PaginationOptions } from '../models/PaginationOptions';
import { MarketplacePlugin } from '../models/MarketplacePlugin';
import { Api2ResponseFormat } from '../models/ApiResponse';
interface BuiltInBlueprint {
  descriptorVersion: string;
  plugin: MarketplacePlugin;
}
export declare function fetchBlueprints(): Observable<BuiltInBlueprint[]>;
export declare function fetchAll(paginationOptions?: PaginationOptions): Observable<PagedArray<Site>>;
export declare function create(site: CreateSiteMeta): Observable<Site>;
export declare function trash(id: string): Observable<boolean>;
export declare function update(site: Omit<Site, 'uuid' | 'imageUrl'>): Observable<Api2ResponseFormat<{}>>;
export declare function exists(siteId: string): Observable<boolean>;
export declare function validateActionPolicy(site: string, action: Action): Observable<ContentValidationResult>;
export declare function validateActionPolicy(site: string, actions: Action[]): Observable<ContentValidationResult[]>;
export declare function fetchLegacySite(siteId: string): Observable<LegacySite>;
export declare function hasInitialPublish(siteId: string): Observable<boolean>;
export {};