Plugin Tools API.

export declare function buildPlugin(options?: PluginBuildOptions): Promise<PluginBuildResult>;

export declare function checkPlugin(options?: Omit<PluginBuildOptions, 'publish'>): Promise<PluginBuildResult>;

export declare function createPluginArchive(artifactDirectory: string, destination: string): Promise<{
    readonly path: string;
    readonly byteLength: number;
}>;

export declare function definePluginConfig<const Config extends EditfulPluginConfig>(config: Config): Config;

export declare function formatBytes(bytes: number): string;

export declare function loadPluginConfig(projectDirectory: string, explicitPath?: string): Promise<ResolvedEditfulPluginConfig>;

export declare function packPlugin(options?: PluginBuildOptions & {
    readonly archivePath?: string;
}): Promise<PluginPackResult>;

export interface EditfulPluginAssets {
    /** Passive SVG toolbar icons copied into the artifact at the same path. */
    readonly icons?: readonly string[];
}

export interface EditfulPluginConfig {
    readonly schemaVersion?: 1 | 2;
    readonly id: string;
    readonly name: string;
    readonly description: string;
    readonly version: string;
    /** Project-relative TypeScript, TSX, or JavaScript source entry. */
    readonly entry: string;
    /** Inferred from the installed SDK when omitted. */
    readonly sdkVersion?: string;
    readonly minAppVersion: string;
    readonly maxAppVersion: string;
    readonly capabilities: readonly PluginCapability[];
    readonly network?: readonly PluginNetworkDeclaration[];
    readonly remoteMedia?: readonly PluginRemoteMediaDeclaration[];
    readonly settings?: readonly PluginSettingDeclaration[];
    readonly secrets?: readonly PluginSecretDeclaration[];
    readonly author?: string;
    readonly homepage?: string;
    readonly source?: string;
    readonly assets?: EditfulPluginAssets;
    /** Project-relative artifact root. Defaults to `dist`. */
    readonly outDir?: string;
}

export interface PluginBuildOptions {
    readonly projectDirectory?: string;
    readonly config?: string;
    readonly outputRoot?: string;
    readonly development?: boolean;
    readonly publish?: boolean;
}

export interface PluginBuildResult {
    readonly artifactDirectory: string;
    readonly manifest: PluginManifest;
    readonly bundleBytes: number;
    readonly maximumBundleBytes: number;
}

export interface PluginPackResult extends PluginBuildResult {
    readonly archivePath: string;
    readonly archiveBytes: number;
}

export interface ResolvedEditfulPluginConfig extends Omit<EditfulPluginConfig, 'schemaVersion' | 'sdkVersion' | 'entry' | 'outDir'> {
    readonly schemaVersion: 1 | 2;
    readonly sdkVersion: string;
    readonly projectDirectory: string;
    readonly configPath: string;
    readonly entryPath: string;
    readonly outputRoot: string;
    readonly artifactName: string;
}