picgo/dist/utils/interfaces.d.ts

A tool for image uploading

/** This file is deprecated */
import { PicGo } from '../core/PicGo';
import LifecyclePlugins from '../lib/LifecyclePlugins';
/**
 * Snapshot of the currently displayed values for all fields in a plugin config form.
 * See `src/types/index.ts` for canonical documentation.
 */
export type PluginConfigAnswers = Record<string, unknown>;
export type IPluginConfigChoice = string | {
    name?: string;
    value: unknown;
    checked?: boolean;
};
/**
 * for plugin config
 *
 * See `src/types/index.ts` for canonical documentation including the list of
 * known `type` values (`'input' | 'password' | 'list' | 'checkbox' |
 * 'confirm' | 'editor'`) and reactive `choices` / `default` examples.
 */
export interface IPluginConfig {
    name: string;
    type: string;
    required: boolean;
    default?: any | ((answers: PluginConfigAnswers) => any);
    choices?: IPluginConfigChoice[] | ((answers: PluginConfigAnswers) => IPluginConfigChoice[]);
    dependsOn?: string[];
    [propName: string]: any;
}
/**
 * for lifecycle plugins
 */
export interface IHelper {
    transformer: LifecyclePlugins;
    uploader: LifecyclePlugins;
    beforeTransformPlugins: LifecyclePlugins;
    beforeUploadPlugins: LifecyclePlugins;
    afterUploadPlugins: LifecyclePlugins;
    afterFinishPlugins: LifecyclePlugins;
}
/**
 * for uploading image info
 */
export interface IImgInfo {
    id?: string;
    buffer?: Buffer;
    base64Image?: string;
    fileName?: string;
    width?: number;
    height?: number;
    extname?: string;
    contentType?: string;
    mimeType?: string;
    createdAt?: number | string | Date;
    updatedAt?: number | string | Date;
    [propName: string]: any;
}
export interface IPathTransformedImgInfo extends IImgInfo {
    success: boolean;
}
/** SM.MS 图床配置项 */
export interface ISmmsConfig {
    token: string;
}
/** 七牛云图床配置项 */
export interface IQiniuConfig {
    accessKey: string;
    secretKey: string;
    /** 存储空间名 */
    bucket: string;
    /** 自定义域名 */
    url: string;
    /** 存储区域编号 */
    area: 'z0' | 'z1' | 'z2' | 'na0' | 'as0';
    /** 网址后缀，比如使用 `?imageslim` 可进行[图片瘦身](https://developer.qiniu.com/dora/api/1271/image-thin-body-imageslim) */
    options: string;
    /** 自定义存储路径，比如 `img/` */
    path: string;
}
/** 又拍云图床配置项 */
export interface IUpyunConfig {
    /** 存储空间名，及你的服务名 */
    bucket: string;
    /** 操作员 */
    operator: string;
    /** 密码 */
    password: string;
    /** 针对图片的一些后缀处理参数 */
    options: string;
    /** 自定义存储路径，比如 `img/` */
    path: string;
    /** 加速域名，注意要加 `http://` 或者 `https://` */
    url: string;
}
/** 腾讯云图床配置项 */
export interface ITcyunConfig {
    secretId: string;
    secretKey: string;
    /** 存储桶名，v4 和 v5 版本不一样 */
    bucket: string;
    appId: string;
    /** 存储区域，例如 ap-beijing-1 */
    area: string;
    /** 自定义存储路径，比如 img/ */
    path: string;
    /** 自定义域名，注意要加 `http://` 或者 `https://` */
    customUrl: string;
    /** COS 版本，v4 或者 v5 */
    version: 'v5' | 'v4';
}
/** GitHub 图床配置项 */
export interface IGithubConfig {
    /** 仓库名，格式是 `username/reponame` */
    repo: string;
    /** github token */
    token: string;
    /** 自定义存储路径，比如 `img/` */
    path: string;
    /** 自定义域名，注意要加 `http://` 或者 `https://` */
    customUrl: string;
    /** 分支名，默认是 `master` */
    branch: string;
}
/** 阿里云图床配置项 */
export interface IAliyunConfig {
    accessKeyId: string;
    accessKeySecret: string;
    /** 存储空间名 */
    bucket: string;
    /** 存储区域代号 */
    area: string;
    /** 自定义存储路径 */
    path: string;
    /** 自定义域名，注意要加 `http://` 或者 `https://` */
    customUrl: string;
    /** 针对图片的一些后缀处理参数 PicGo 2.2.0+ PicGo-Core 1.4.0+ */
    options: string;
}
/** Imgur 图床配置项 */
export interface IImgurConfig {
    /** imgur 的 `clientId` */
    clientId: string;
    /** 代理地址，仅支持 http 代理 */
    proxy: string;
}
/** PicGo 配置文件类型定义 */
export interface IConfig {
    picBed: {
        uploader: string;
        current?: string;
        smms?: ISmmsConfig;
        qiniu?: IQiniuConfig;
        upyun?: IUpyunConfig;
        tcyun?: ITcyunConfig;
        github?: IGithubConfig;
        aliyun?: IAliyunConfig;
        imgur?: IImgurConfig;
        transformer?: string;
        proxy: string;
    };
    picgoPlugins: {
        [propName: string]: boolean;
    };
    debug?: boolean;
    silent?: boolean;
    settings?: {
        logLevel: string;
        logPath: string;
    };
    /** 下载插件时 npm 命令自定义的 registry */
    registry: string;
}
/**
 * for plugin
 */
export interface IPlugin {
    handle: ((ctx: PicGo) => Promise<any>) | ((ctx: PicGo) => void);
    [propName: string]: any;
}
/**
 * for spawn output
 */
export interface IResult {
    code: number;
    data: string;
}
/**
 * for transformer - path
 */
export interface IImgSize {
    width: number;
    height: number;
    real?: boolean;
}
/**
 * for clipboard image
 */
export interface IClipboardImage {
    imgPath: string;
    isExistFile: boolean;
}
/**
 * for install command environment variable
 */
export interface IProcessEnv {
    [propName: string]: Undefinable<string>;
}
export type ILogArgvType = string | number;
export type ILogArgvTypeWithError = ILogArgvType | Error;
export type Nullable<T> = T | null;
export type Undefinable<T> = T | undefined;