@craftercms/studio-ui/services/marketplace.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 {
  LookupTable,
  MarketplacePlugin,
  MarketplacePluginVersion,
  MarketplaceSite,
  PagedArray,
  PluginRecord,
  SandboxItem
} from '../models';
import { Observable } from 'rxjs';
export declare function fetchBlueprints(options?: {
  type?: string;
  limit?: number;
  showIncompatible?: boolean;
}): Observable<PagedArray<MarketplacePlugin>>;
interface MarketplacePluginSearchOptions {
  type: string;
  limit: number;
  offset: number;
  keywords: string;
  showIncompatible: boolean;
}
export declare function fetchMarketplacePlugins(
  options: Partial<MarketplacePluginSearchOptions>
): Observable<PagedArray<MarketplacePlugin>>;
export declare function installMarketplacePlugin(
  siteId: string,
  pluginId: string,
  pluginVersion: MarketplacePluginVersion,
  parameters?: LookupTable<string>
): Observable<boolean>;
export declare function uninstallMarketplacePlugin(
  siteId: string,
  pluginId: string,
  force?: boolean
): Observable<boolean>;
export declare function getPluginConfiguration(siteId: string, pluginId: string): Observable<string>;
export declare function setPluginConfiguration(siteId: string, pluginId: string, content: string): Observable<boolean>;
export declare function fetchMarketplacePluginUsage(siteId: string, pluginId: string): Observable<SandboxItem[]>;
export declare function fetchInstalledMarketplacePlugins(siteId: string): Observable<PluginRecord[]>;
export declare function createSite(site: MarketplaceSite): Observable<boolean>;
export {};