@craftercms/studio-ui/models/MarketplacePlugin.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/>.
 */

export interface MarketplacePluginImage {
  url: string;
  title: string;
  description: string;
}
export interface MarketplacePluginVideo {
  title: string;
  description: string;
  url: string;
}
interface MarketplacePluginMedia {
  screenshots: [MarketplacePluginImage];
  videos?: [MarketplacePluginVideo] | [];
}
export interface MarketplacePluginVersion {
  major: number;
  minor: number;
  patch: number;
}
export interface MarketplacePluginParameter {
  label: string;
  name: string;
  required: boolean;
  type: string;
  description: string;
  defaultValue: string;
}
export interface MarketplacePlugin {
  id: string;
  type?: string;
  name: string;
  tags?: string[];
  version?: MarketplacePluginVersion;
  description: string;
  documentation: string;
  website?: {
    name: string;
    url: string;
  };
  media: MarketplacePluginMedia;
  developer?: {
    people: any;
    company?: {
      name: string;
      url: string;
    };
  };
  build?: {
    id: string;
    url: string;
  };
  license?: {
    name: string;
    url: string;
  };
  crafterCmsVersions?: [MarketplacePluginVersion];
  crafterCmsEditions?: string[];
  parameters?: [MarketplacePluginParameter];
  status?: string;
  source?: string;
  compatible?: boolean;
  searchEngine?: string;
  url?: string;
  ref?: string;
}
export {};