piclist 0.0.1

package/dist/types/index.d.ts

@@ -0,0 +1,537 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Command } from 'commander';
+import { Inquirer } from 'inquirer';
+import { IRequestPromiseOptions } from './oldRequest';
+export interface IPicGo extends NodeJS.EventEmitter {
+    /**
+     * picgo configPath
+     *
+     * if do not provide, then it will use default configPath
+     */
+    configPath: string;
+    /**
+     * the picgo configPath's baseDir
+     */
+    baseDir: string;
+    /**
+     * picgo logger factory
+     */
+    log: ILogger;
+    /**
+     * picgo commander, for cli
+     */
+    cmd: ICommander;
+    /**
+     * after transformer, the input will be output
+     */
+    output: IImgInfo[];
+    /**
+     * the origin input
+     */
+    input: any[];
+    /**
+     * register\unregister\get picgo's plugin
+     */
+    pluginLoader: IPluginLoader;
+    /**
+     * install\uninstall\update picgo's plugin via npm
+     */
+    pluginHandler: IPluginHandler;
+    /**
+     * @deprecated will be removed in v1.5.0+
+     *
+     * use request instead.
+     *
+     * http request tool
+     */
+    Request: IRequest;
+    /**
+     * plugin system core part transformer\uploader\beforeTransformPlugins...
+     */
+    helper: IHelper;
+    /**
+     * picgo-core version
+     */
+    VERSION: string;
+    /**
+     * electron picgo's version
+     */
+    GUI_VERSION?: string;
+    /**
+     * will be released in v1.5.0+
+     *
+     * replace old Request
+     *
+     * http request tool
+     */
+    request: IRequest['request'];
+    i18n: II18nManager;
+    /**
+     * get picgo config
+     */
+    getConfig: <T>(name?: string) => T;
+    /**
+     * save picgo config to configPath
+     */
+    saveConfig: (config: IStringKeyMap<any>) => void;
+    /**
+     * remove some [propName] in config[key] && save config to configPath
+     */
+    removeConfig: (key: string, propName: string) => void;
+    /**
+     * set picgo config to ctx && will not save to configPath
+     */
+    setConfig: (config: IStringKeyMap<any>) => void;
+    /**
+     * unset picgo config to ctx && will not save to configPath
+     */
+    unsetConfig: (key: string, propName: string) => void;
+    /**
+     * upload gogogo
+     */
+    upload: (input?: any[]) => Promise<IImgInfo[] | Error>;
+}
+/**
+ * for plugin config
+ */
+export interface IPluginConfig {
+    name: string;
+    type: string;
+    required: boolean;
+    default?: any;
+    alias?: string;
+    message?: string;
+    prefix?: string;
+    [propName: string]: any;
+}
+/**
+ * for lifecycle plugins
+ */
+export interface ILifecyclePlugins {
+    register: (id: string, plugin: IPlugin) => void;
+    unregister: (id: string) => void;
+    getName: () => string;
+    get: (id: string) => IPlugin | undefined;
+    getList: () => IPlugin[];
+    getIdList: () => string[];
+}
+export interface IHelper {
+    transformer: ILifecyclePlugins;
+    uploader: ILifecyclePlugins;
+    beforeTransformPlugins: ILifecyclePlugins;
+    beforeUploadPlugins: ILifecyclePlugins;
+    afterUploadPlugins: ILifecyclePlugins;
+}
+export interface ICommander extends ILifecyclePlugins {
+    program: Command;
+    inquirer: Inquirer;
+}
+export interface IPluginLoader {
+    /**
+     * register [local plugin] or [provided plugin]
+     *
+     * if the second param (plugin) is provided
+     *
+     * then picgo will register this plugin and enable it by default
+     *
+     * but picgo won't write any config to config file
+     *
+     * you should use ctx.setConfig to change the config context
+     */
+    registerPlugin: (name: string, plugin?: IPicGoPlugin) => void;
+    unregisterPlugin: (name: string) => void;
+    getPlugin: (name: string) => IPicGoPluginInterface | undefined;
+    /**
+     * get enabled plugin list
+     */
+    getList: () => string[];
+    /**
+     * get all plugin list (enabled or not)
+     */
+    getFullList: () => string[];
+    hasPlugin: (name: string) => boolean;
+}
+export interface IRequestOld {
+    request: import('axios').AxiosInstance;
+}
+export declare type IOldReqOptions = Omit<IRequestPromiseOptions & {
+    url: string;
+}, 'auth'>;
+export declare type IOldReqOptionsWithFullResponse = IOldReqOptions & {
+    resolveWithFullResponse: true;
+};
+export declare type IOldReqOptionsWithJSON = IOldReqOptions & {
+    json: true;
+};
+/**
+ * for PicGo new request api, the response will be json format
+ */
+export declare type IReqOptions<T = any> = AxiosRequestConfig<T> & {
+    resolveWithFullResponse: true;
+};
+/**
+ * for PicGo new request api, the response will be Buffer
+ */
+export declare type IReqOptionsWithArrayBufferRes<T = any> = IReqOptions<T> & {
+    responseType: 'arraybuffer';
+};
+/**
+ * for PicGo new request api, the response will be just response data. (not statusCode, headers, etc.)
+ */
+export declare type IReqOptionsWithBodyResOnly<T = any> = AxiosRequestConfig<T>;
+export declare type IFullResponse<T = any, U = any> = AxiosResponse<T, U> & {
+    statusCode: number;
+    body: T;
+};
+declare type AxiosResponse<T = any, U = any> = import('axios').AxiosResponse<T, U>;
+declare type AxiosRequestConfig<T = any> = import('axios').AxiosRequestConfig<T>;
+interface IRequestOptionsWithFullResponse {
+    resolveWithFullResponse: true;
+}
+interface IRequestOptionsWithJSON {
+    json: true;
+}
+interface IRequestOptionsWithResponseTypeArrayBuffer {
+    responseType: 'arraybuffer';
+}
+/**
+ * T is the response data type
+ * U is the config type
+ */
+export declare type IResponse<T, U> = U extends IRequestOptionsWithFullResponse ? IFullResponse<T, U> : U extends IRequestOptionsWithJSON ? T : U extends IRequestOptionsWithResponseTypeArrayBuffer ? Buffer : U extends IOldReqOptionsWithFullResponse ? IFullResponse<T, U> : U extends IOldReqOptionsWithJSON ? T : U extends IOldReqOptions ? string : U extends IReqOptionsWithBodyResOnly ? T : string;
+/**
+ * the old request lib will be removed in v1.5.0+
+ * the request options have the following properties
+ */
+export interface IRequestLibOnlyOptions {
+    proxy?: string;
+    body?: any;
+    formData?: {
+        [key: string]: any;
+    } | undefined;
+    form?: {
+        [key: string]: any;
+    } | string | undefined;
+}
+export declare type IRequestConfig<T> = T extends IRequestLibOnlyOptions ? IOldReqOptions : AxiosRequestConfig;
+export interface IRequest {
+    request: <T, U extends (IRequestConfig<U> extends IOldReqOptions ? IOldReqOptions : IRequestConfig<U> extends AxiosRequestConfig ? AxiosRequestConfig : never)>(config: U) => Promise<IResponse<T, U>>;
+}
+export declare type ILogColor = 'blue' | 'green' | 'yellow' | 'red';
+/**
+ * for uploading image info
+ */
+export interface IImgInfo {
+    buffer?: Buffer;
+    base64Image?: string;
+    fileName?: string;
+    width?: number;
+    height?: number;
+    extname?: string;
+    imgUrl?: string;
+    [propName: string]: any;
+}
+export interface IPathTransformedImgInfo extends IImgInfo {
+    success: boolean;
+}
+export interface IStringKeyMap<T> {
+    [key: string]: T extends T ? T : any;
+}
+export interface ICLIConfigs {
+    [module: string]: IStringKeyMap<any>;
+}
+/** SM.MS 图床配置项 */
+export interface ISmmsConfig {
+    token: string;
+    backupDomain?: string;
+}
+/** 七牛云图床配置项 */
+export interface IQiniuConfig {
+    accessKey: string;
+    secretKey: string;
+    /** 存储空间名 */
+    bucket: string;
+    /** 自定义域名 */
+    url: string;
+    /** 存储区域编号 */
+    area: 'z0' | 'z1' | 'z2' | 'na0' | 'as0' | string;
+    /** 网址后缀，比如使用 `?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';
+    /** 针对图片的一些后缀处理参数 PicGo 2.4.0+ PicGo-Core 1.5.0+ */
+    options: string;
+}
+/** GitHub 图床配置项 */
+export interface IGithubConfig {
+    /** 仓库名，格式是 `username/reponame` */
+    repo: string;
+    /** github token */
+    token: string;
+    /** 自定义存储路径，比如 `img/` */
+    path: string;
+    /** 自定义域名，注意要加 `http://` 或者 `https://` */
+    customUrl: string;
+    /** 分支名，默认是 `main` */
+    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;
+        /** for uploader */
+        proxy?: string;
+        [others: string]: any;
+    };
+    picgoPlugins: {
+        [pluginName: string]: boolean;
+    };
+    debug?: boolean;
+    silent?: boolean;
+    settings?: {
+        logLevel?: string;
+        logPath?: string;
+        /** for npm */
+        registry?: string;
+        /** for npm */
+        proxy?: string;
+        [others: string]: any;
+    };
+    [configOptions: string]: any;
+}
+/**
+ * for an uploader/transformer/beforeTransformHandler/beforeUploadHandler/afterUploadHandler
+ */
+export interface IPlugin {
+    handle: ((ctx: IPicGo) => Promise<any>) | ((ctx: IPicGo) => void);
+    /** The name of this handler */
+    name?: string;
+    /** The config of this handler */
+    config?: (ctx: IPicGo) => IPluginConfig[];
+    [propName: string]: any;
+}
+export declare type IPluginNameType = 'simple' | 'scope' | 'normal' | 'unknown';
+export interface IPluginProcessResult {
+    success: boolean;
+    /**
+     * the package.json's name filed
+     */
+    pkgName: string;
+    /**
+     * the plugin name or the fs absolute path
+     */
+    fullName: string;
+}
+export interface IPluginHandler {
+    install: (plugins: string[], options: IPluginHandlerOptions, env?: IProcessEnv) => Promise<IPluginHandlerResult<boolean>>;
+    update: (plugins: string[], options: IPluginHandlerOptions, env?: IProcessEnv) => Promise<IPluginHandlerResult<boolean>>;
+    uninstall: (plugins: string[]) => Promise<IPluginHandlerResult<boolean>>;
+}
+export interface IPluginHandlerResult<T> {
+    success: T;
+    body: T extends true ? string[] : string;
+}
+export interface IPluginHandlerOptions {
+    proxy?: string;
+    registry?: string;
+}
+/**
+ * for picgo npm plugins
+ */
+export declare type IPicGoPlugin = (ctx: IPicGo) => IPicGoPluginInterface;
+/**
+ * interfaces for PicGo plugin
+ */
+export interface IPicGoPluginInterface {
+    /**
+     * since PicGo-Core v1.5, register will inject ctx
+     */
+    register: (ctx: IPicGo) => void;
+    /**
+     * this plugin's config
+     */
+    config?: (ctx: IPicGo) => IPluginConfig[];
+    /**
+     * register uploader name
+     */
+    uploader?: string;
+    /**
+     * register transformer name
+     */
+    transformer?: string;
+    /**
+     * for picgo gui plugins
+     */
+    guiMenu?: (ctx: IPicGo) => IGuiMenuItem[];
+    /**
+     * for picgo gui plugins
+     * short key -> command
+     */
+    commands?: (ctx: IPicGo) => ICommandItem[];
+    [propName: string]: any;
+}
+export interface IGuiMenuItem {
+    label: string;
+    handle: (ctx: IPicGo, guiApi: any) => Promise<void>;
+}
+export interface ICommandItem {
+    label: string;
+    name: string;
+    key: string;
+    handle: (ctx: IPicGo, guiApi: any) => Promise<void>;
+}
+/**
+ * for spawn output
+ */
+export interface IResult {
+    code: number;
+    data: string;
+}
+/**
+ * for transformer - path
+ */
+export interface IImgSize {
+    width: number;
+    height: number;
+    real?: boolean;
+}
+/**
+ * for initUtils
+ */
+export interface IFileTree {
+    [filePath: string]: string | Buffer;
+}
+export interface IOptions {
+    template: string;
+    dest: string;
+    hasSlash: boolean;
+    inPlace: boolean;
+    clone: boolean;
+    offline: boolean;
+    tmp: string;
+    project: string;
+}
+/**
+ * for clipboard image
+ */
+export interface IClipboardImage {
+    imgPath: string;
+    /**
+     * if the path is generate by picgo -> false
+     * if the path is a real file path in system -> true
+     */
+    shouldKeepAfterUploading: boolean;
+}
+/**
+ * for install command environment variable
+ */
+export interface IProcessEnv {
+    [propName: string]: Undefinable<string>;
+}
+export declare type ILogArgvType = string | number;
+export declare type ILogArgvTypeWithError = ILogArgvType | Error;
+export declare type Nullable<T> = T | null;
+export declare type Undefinable<T> = T | undefined;
+export interface ILogger {
+    success: (...msg: ILogArgvType[]) => void;
+    info: (...msg: ILogArgvType[]) => void;
+    error: (...msg: ILogArgvTypeWithError[]) => void;
+    warn: (...msg: ILogArgvType[]) => void;
+    debug: (...msg: ILogArgvType[]) => void;
+}
+export interface IConfigChangePayload<T> {
+    configName: string;
+    value: T;
+}
+export interface ILocale {
+    [key: string]: any;
+}
+export interface II18nManager {
+    /**
+     * translate text
+     */
+    translate: <T extends string>(key: T, args?: IStringKeyMap<string>) => string;
+    /**
+     * add locale to current i18n language
+     * default locale list
+     * - zh-CN
+     * - en
+     */
+    addLocale: (language: string, locales: ILocale) => boolean;
+    /**
+     * set current language
+     */
+    setLanguage: (language: string) => void;
+    /**
+     * dynamic add new language & locales
+     */
+    addLanguage: (language: string, locales: ILocale) => boolean;
+    /**
+     * get language list
+     */
+    getLanguageList: () => string[];
+}
+export {};

package/dist/types/oldRequest.d.ts

@@ -0,0 +1,19 @@
+export declare type IMethod = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+export interface IHeaders {
+    [key: string]: any;
+}
+export interface IRequestPromiseOptions {
+    baseUrl?: string | undefined;
+    url?: string;
+    method?: IMethod;
+    formData?: {
+        [key: string]: any;
+    } | undefined;
+    qs?: any;
+    json?: boolean;
+    body?: any;
+    resolveWithFullResponse?: boolean;
+    headers?: IHeaders;
+    proxy?: any;
+    timeout?: number;
+}

package/dist/utils/common.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { IImgSize, IPathTransformedImgInfo, IPluginNameType, ILogger, IPicGo } from '../types';
+export declare const isUrl: (url: string) => boolean;
+export declare const isUrlEncode: (url: string) => boolean;
+export declare const handleUrlEncode: (url: string) => string;
+export declare const getImageSize: (file: Buffer) => IImgSize;
+export declare const getFSFile: (filePath: string) => Promise<IPathTransformedImgInfo>;
+export declare const getURLFile: (url: string, ctx: IPicGo) => Promise<IPathTransformedImgInfo>;
+/**
+ * detect the input string's type
+ * for example
+ * 1. @xxx/picgo-plugin-xxx -> scope
+ * 2. picgo-plugin-xxx -> normal
+ * 3. xxx -> simple
+ * 4. not exists or is a path -> unknown
+ * @param name
+ */
+export declare const getPluginNameType: (name: string) => IPluginNameType;
+/**
+ * detect the input string is a simple plugin name or not
+ * for example
+ * 1. xxx -> true
+ * 2. /Usr/xx/xxxx/picgo-plugin-xxx -> false
+ * @param name pluginNameOrPath
+ */
+export declare const isSimpleName: (nameOrPath: string) => boolean;
+/**
+ * streamline the full plugin name to a simple one
+ * for example:
+ * 1. picgo-plugin-xxx -> xxx
+ * 2. @xxx/picgo-plugin-yyy -> yyy
+ * @param name pluginFullName
+ */
+export declare const handleStreamlinePluginName: (name: string) => string;
+/**
+ * complete plugin name to full name
+ * for example:
+ * 1. xxx -> picgo-plugin-xxx
+ * 2. picgo-plugin-xxx -> picgo-plugin-xxx
+ * @param name pluginSimpleName
+ * @param scope pluginScope
+ */
+export declare const handleCompletePluginName: (name: string, scope?: string) => string;
+/**
+ * handle install/uninstall/update plugin name or path
+ * for example
+ * 1. picgo-plugin-xxx -> picgo-plugin-xxx
+ * 2. @xxx/picgo-plugin-xxx -> @xxx/picgo-plugin-xxx
+ * 3. xxx -> picgo-plugin-xxx
+ * 4. ./xxxx/picgo-plugin-xxx -> /absolutePath/.../xxxx/picgo-plugin-xxx
+ * 5. /absolutePath/.../picgo-plugin-xxx -> /absolutePath/.../picgo-plugin-xxx
+ * @param nameOrPath pluginName or pluginPath
+ */
+export declare const getProcessPluginName: (nameOrPath: string, logger?: ILogger | Console) => string;
+/**
+ * get the normal plugin name
+ * for example:
+ * 1. picgo-plugin-xxx -> picgo-plugin-xxx
+ * 2. @xxx/picgo-plugin-xxx -> @xxx/picgo-plugin-xxx
+ * 3. ./xxxx/picgo-plugin-xxx -> picgo-plugin-xxx
+ * 4. /absolutePath/.../picgo-plugin-xxx -> picgo-plugin-xxx
+ * 5. an exception: [package.json's name] !== [folder name]
+ * then use [package.json's name], usually match the scope package.
+ * 6. if plugin name has version: picgo-plugin-xxx@x.x.x then remove the version
+ * @param nameOrPath
+ */
+export declare const getNormalPluginName: (nameOrPath: string, logger?: ILogger | Console) => string;
+/**
+ * handle transform the path to unix style
+ * for example
+ * 1. C:\\xxx\\xxx -> C:/xxx/xxx
+ * 2. /xxx/xxx -> /xxx/xxx
+ * @param path
+ */
+export declare const handleUnixStylePath: (pathStr: string) => string;
+/**
+ * remove plugin version when register plugin name
+ * 1. picgo-plugin-xxx@1.0.0 -> picgo-plugin-xxx
+ * 2. @xxx/picgo-plugin-xxx@1.0.0 -> @xxx/picgo-plugin-xxx
+ * @param nameOrPath
+ * @param scope
+ */
+export declare const removePluginVersion: (nameOrPath: string, scope?: boolean) => string;
+/**
+ * the config black item list which won't be setted
+ * only can be got
+ */
+export declare const configBlackList: never[];
+/**
+ * check some config key is in blackList
+ * @param key
+ */
+export declare const isConfigKeyInBlackList: (key: string) => boolean;
+/**
+ * check the input config is valid
+ * config must be object such as { xxx: 'xxx' }
+ * && can't be array
+ * @param config
+ * @returns
+ */
+export declare const isInputConfigValid: (config: any) => boolean;
+export declare function safeParse<T>(str: string): T | string;
+export declare const forceNumber: (num?: string | number) => number;
+export declare const isDev: () => boolean;
+export declare const isProd: () => boolean;

package/dist/utils/createContext.d.ts

@@ -0,0 +1,6 @@
+import { IPicGo } from '../types';
+/**
+ * create an unique context for each upload process
+ * @param ctx
+ */
+export declare const createContext: (ctx: IPicGo) => IPicGo;

package/dist/utils/db.d.ts

@@ -0,0 +1,15 @@
+import { IConfig, IPicGo } from '../types';
+import { IJSON } from '@picgo/store/dist/types';
+declare class DB {
+    private readonly ctx;
+    private readonly db;
+    constructor(ctx: IPicGo);
+    read(flush?: boolean): IJSON;
+    get(key?: string): any;
+    set(key: string, value: any): void;
+    has(key: string): boolean;
+    unset(key: string, value: any): boolean;
+    saveConfig(config: Partial<IConfig>): void;
+    removeConfig(config: IConfig): void;
+}
+export default DB;