universal-picgo 1.12.1 → 2.0.0

package/dist/src/plugins/uploader/s3/uploader.d.ts

@@ -1,30 +0,0 @@
-import { IAwsS3Config, IImgInfo, IPicGo } from '../../../types';
-import { S3Client, ObjectCannedACL } from '@aws-sdk/client-s3';
-
-export interface IUploadResult {
-    index: number;
-    key: string;
-    url: string;
-    imgURL: string;
-    versionId?: string;
-    eTag?: string;
-}
-declare function createS3Client(ctx: IPicGo, opts: IAwsS3Config): S3Client;
-interface createUploadTaskOpts {
-    client: S3Client;
-    bucketName: string;
-    path: string;
-    item: IImgInfo;
-    index: number;
-    acl: ObjectCannedACL | undefined;
-    customUrl?: string;
-    corsProxy?: boolean;
-}
-declare function createUploadTask(opts: createUploadTaskOpts): Promise<IUploadResult>;
-declare function getFileURL(opts: createUploadTaskOpts, eTag: string, versionId: string): Promise<string>;
-declare const _default: {
-    createS3Client: typeof createS3Client;
-    createUploadTask: typeof createUploadTask;
-    getFileURL: typeof getFileURL;
-};
-export default _default;

package/dist/src/plugins/uploader/s3/utils.d.ts

@@ -1,8 +0,0 @@
-import { IImgInfo } from '../../../types';
-
-export declare function formatPath(info: IImgInfo, format?: string): string;
-export declare function extractInfo(info: IImgInfo): Promise<{
-    body?: Buffer;
-    contentType?: string;
-    contentEncoding?: string;
-}>;

package/dist/src/plugins/uploader/smms.d.ts

@@ -1,3 +0,0 @@
-import { IPicGo } from '../../types';
-
-export default function register(ctx: IPicGo): void;

package/dist/src/plugins/uploader/tcyun.d.ts

@@ -1,9 +0,0 @@
-import { IPicGo } from '../../types';
-
-export interface ISignature {
-    signature: string;
-    appId: string;
-    bucket: string;
-    signTime: string;
-}
-export default function register(ctx: IPicGo): void;

package/dist/src/plugins/uploader/upyun/index.d.ts

@@ -1,3 +0,0 @@
-import { IPicGo } from '../../../types';
-
-export default function register(ctx: IPicGo): void;

package/dist/src/utils/CodingUtil.d.ts

@@ -1,39 +0,0 @@
-import { Buffer } from './nodePolyfill';
-
-/**
- * 提供编码和解码相关的实用方法
- *
- * @author terwer
- * @since 1.8.0
- */
-declare class CodingUtil {
-    /**
-     * 编码字符串为 base64 格式
-     *
-     * @returns 编码后的 base64 字符串
-     * @param input -  string | Uint8Array | ArrayBuffer
-     */
-    static encodeToBase64String(input: any): string;
-    /**
-     * 解码 base64
-     *
-     * @returns 解码后的值
-     * @param input - 要解码的 base64 字符串
-     */
-    static decodeBase64(input: string): Buffer;
-    /**
-     * 编码字符串为十六进制格式
-     *
-     * @param input 要编码的字符串
-     * @returns 编码后的十六进制字符串
-     */
-    static encodeToHexString(input: string): string;
-    /**
-     * 解码十六进制
-     *
-     * @param input 要解码的十六进制字符串
-     * @returns 解码后的值
-     */
-    static decodeHex(input: string): Buffer;
-}
-export { CodingUtil };

package/dist/src/utils/CodingUtil.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/utils/browserUtils.d.ts

@@ -1,12 +0,0 @@
-/**
- * 获取浏览器目录
- *
- * @param path 完整的路径
- */
-export declare const getBrowserDirectoryPath: (path: string) => string;
-/**
- * 浏览器路径拼接
- *
- * @param paths 路径数组
- */
-export declare const browserPathJoin: (...paths: string[]) => string;

package/dist/src/utils/clipboard/browser.d.ts

@@ -1,4 +0,0 @@
-import { IClipboardImage, IPicGo } from '../../types';
-
-declare const getClipboardImageBrowser: (ctx: IPicGo) => Promise<IClipboardImage>;
-export { getClipboardImageBrowser };

package/dist/src/utils/clipboard/electron.d.ts

@@ -1,4 +0,0 @@
-import { IClipboardImage, IPicGo } from '../../types';
-
-declare const getClipboardImageElectron: (ctx: IPicGo) => Promise<IClipboardImage>;
-export { getClipboardImageElectron };

package/dist/src/utils/common.d.ts

@@ -1,135 +0,0 @@
-import { ILogger } from 'zhi-lib-base';
-import { Buffer } from './nodePolyfill';
-import { win } from 'universal-picgo-store';
-import { IImgSize, IPathTransformedImgInfo, IPicGo, IPluginNameType, Undefinable } from '../types';
-
-export declare const isUrl: (url: string) => boolean;
-/**
- * 检测输入是否为 base64 编码的字符串
- *
- * @param  input - 输入字符串或 Buffer
- * @returns- 如果是 base64 编码则返回 true，否则返回 false
- */
-export declare const isBase64: (input: any) => boolean;
-export declare const base64ToBuffer: (base64: string) => Buffer | typeof win.Buffer;
-export declare const bufferToBase64: (buffer: Buffer | typeof win.Buffer) => any;
-export declare const getBase64File: (base64: string) => Promise<IPathTransformedImgInfo>;
-export declare const getFSFile: (filePath: string) => Promise<IPathTransformedImgInfo>;
-export declare const isFileOrBlob: (val: any) => boolean;
-export declare const isBuffer: (val: any) => boolean;
-/**
- * 将 file 对象转换为 Buffer
- *
- * @param file - file
- * @author terwer
- * @version 0.9.0
- * @since 0.9.0
- */
-export declare const fileToBuffer: (file: any) => Promise<any>;
-export declare const getBlobFile: (blob: any) => 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 nameOrPath 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 transform the path to unix style
- * for example
- * 1. C:\\xxx\\xxx -> C:/xxx/xxx
- * 2. /xxx/xxx -> /xxx/xxx
- * @param pathStr
- */
-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 getImageSize: (file: Buffer | typeof win.Buffer) => IImgSize;
-export declare const calculateMD5: (input: 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
- * @param logger
- */
-export declare const getProcessPluginName: (nameOrPath: string, logger: ILogger) => 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
- * @param logger
- */
-export declare const getNormalPluginName: (nameOrPath: string, logger: ILogger) => string;
-/**
- * 思源笔记代理是否可用
- *
- * @param siyuanProxy
- */
-export declare const isSiyuanProxyAvailable: (siyuanProxy: Undefinable<string>) => boolean | "" | undefined;

package/dist/src/utils/constants.d.ts

@@ -1 +0,0 @@
-export declare const CLIPBOARD_IMAGE_FOLDER = "picgo-clipboard-images";

package/dist/src/utils/createContext.d.ts

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

package/dist/src/utils/enums.d.ts

@@ -1,32 +0,0 @@
-/**
- * these events will be catched by users
- */
-export declare enum IBuildInEvent {
-    UPLOAD_PROGRESS = "uploadProgress",
-    FAILED = "failed",
-    BEFORE_TRANSFORM = "beforeTransform",
-    BEFORE_UPLOAD = "beforeUpload",
-    AFTER_UPLOAD = "afterUpload",
-    FINISHED = "finished",
-    INSTALL = "install",
-    UNINSTALL = "uninstall",
-    UPDATE = "update",
-    NOTIFICATION = "notification"
-}
-/**
- * these events will be catched only by picgo
- */
-export declare enum IBusEvent {
-    CONFIG_CHANGE = "CONFIG_CHANGE"
-}
-/**
- * PicGo 类型枚举
- *
- * @version 1.6.0
- * @since 1.6.0
- * @author terwer
- */
-export declare enum PicgoTypeEnum {
-    Bundled = "bundled",
-    App = "app"
-}

package/dist/src/utils/getClipboardImage.d.ts

@@ -1,4 +0,0 @@
-import { IClipboardImage, IPicGo } from '../types';
-
-declare const getClipboardImage: (ctx: IPicGo) => Promise<IClipboardImage>;
-export default getClipboardImage;

package/dist/src/utils/hashUtil.d.ts

@@ -1,2 +0,0 @@
-declare const calculateHash: (input: string) => string | number;
-export { calculateHash };

package/dist/src/utils/image-size/detector.d.ts

@@ -1,4 +0,0 @@
-import { win } from 'universal-picgo-store';
-import { imageType } from './types';
-
-export declare function detector(input: typeof win.Uint8Array): imageType | undefined;

package/dist/src/utils/image-size/index.d.ts

@@ -1,12 +0,0 @@
-import { win } from 'universal-picgo-store';
-import { imageType } from './types';
-import { ISizeCalculationResult } from './types/interface';
-
-type CallbackFn = (e: Error | null, r?: ISizeCalculationResult) => void;
-export default imageSize;
-export declare function imageSize(input: typeof win.Uint8Array | string): ISizeCalculationResult;
-export declare function imageSize(input: string, callback: CallbackFn): void;
-export declare const disableFS: (v: boolean) => void;
-export declare const disableTypes: (types: imageType[]) => void;
-export declare const setConcurrency: (c: number) => void;
-export declare const types: string[];

package/dist/src/utils/image-size/types/bmp.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const BMP: IImage;

package/dist/src/utils/image-size/types/cur.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const CUR: IImage;

package/dist/src/utils/image-size/types/dds.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const DDS: IImage;

package/dist/src/utils/image-size/types/gif.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const GIF: IImage;

package/dist/src/utils/image-size/types/heif.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const HEIF: IImage;

package/dist/src/utils/image-size/types/icns.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const ICNS: IImage;

package/dist/src/utils/image-size/types/ico.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const ICO: IImage;

package/dist/src/utils/image-size/types/index.d.ts

@@ -1,21 +0,0 @@
-export declare const typeHandlers: {
-    bmp: import('./interface').IImage;
-    cur: import('./interface').IImage;
-    dds: import('./interface').IImage;
-    gif: import('./interface').IImage;
-    heif: import('./interface').IImage;
-    icns: import('./interface').IImage;
-    ico: import('./interface').IImage;
-    j2c: import('./interface').IImage;
-    jp2: import('./interface').IImage;
-    jpg: import('./interface').IImage;
-    ktx: import('./interface').IImage;
-    png: import('./interface').IImage;
-    pnm: import('./interface').IImage;
-    psd: import('./interface').IImage;
-    svg: import('./interface').IImage;
-    tga: import('./interface').IImage;
-    tiff: import('./interface').IImage;
-    webp: import('./interface').IImage;
-};
-export type imageType = keyof typeof typeHandlers;

package/dist/src/utils/image-size/types/interface.d.ts

@@ -1,15 +0,0 @@
-import { win } from 'universal-picgo-store';
-
-export type ISize = {
-    width: number | undefined;
-    height: number | undefined;
-    orientation?: number;
-    type?: string;
-};
-export type ISizeCalculationResult = {
-    images?: ISize[];
-} & ISize;
-export type IImage = {
-    validate: (input: typeof win.Uint8Array) => boolean;
-    calculate: (input: typeof win.Uint8Array, filepath?: string) => ISizeCalculationResult;
-};

package/dist/src/utils/image-size/types/j2c.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const J2C: IImage;

package/dist/src/utils/image-size/types/jp2.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const JP2: IImage;

package/dist/src/utils/image-size/types/jpg.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const JPG: IImage;

package/dist/src/utils/image-size/types/ktx.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const KTX: IImage;

package/dist/src/utils/image-size/types/png.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const PNG: IImage;

package/dist/src/utils/image-size/types/pnm.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const PNM: IImage;

package/dist/src/utils/image-size/types/psd.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const PSD: IImage;

package/dist/src/utils/image-size/types/svg.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const SVG: IImage;

package/dist/src/utils/image-size/types/tga.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const TGA: IImage;

package/dist/src/utils/image-size/types/tiff.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const TIFF: IImage;

package/dist/src/utils/image-size/types/utils.d.ts

@@ -1,17 +0,0 @@
-import { win } from 'universal-picgo-store';
-
-export declare const toUTF8String: (input: typeof win.Uint8Array, start?: number, end?: any) => string;
-export declare const toHexString: (input: typeof win.Uint8Array, start?: number, end?: any) => any;
-export declare const readInt16LE: (input: typeof win.Uint8Array, offset?: number) => number;
-export declare const readUInt16BE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare const readUInt16LE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare const readUInt24LE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare const readInt32LE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare const readUInt32BE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare const readUInt32LE: (input: typeof win.Uint8Array, offset?: number) => any;
-export declare function readUInt(input: typeof win.Uint8Array, bits: 16 | 32, offset: number, isBigEndian: boolean): number;
-export declare function findBox(buffer: typeof win.Uint8Array, boxName: string, offset: number): {
-    name: string;
-    offset: number;
-    size: any;
-} | undefined;

package/dist/src/utils/image-size/types/webp.d.ts

@@ -1,3 +0,0 @@
-import { IImage } from './interface';
-
-export declare const WEBP: IImage;

package/dist/src/utils/nodePolyfill.d.ts

@@ -1,4 +0,0 @@
-import { Buffer } from 'node:buffer';
-import { EventEmitter } from 'node:events';
-
-export { EventEmitter, Buffer };

package/dist/src/utils/nodeUtils.d.ts

@@ -1,31 +0,0 @@
-/**
- * 实现 fs.pathExistsSync 函数
- *
- * @param fs
- * @param path
- * @param filePath
- */
-export declare const pathExistsSync: (fs: any, path: any, filePath: string) => boolean;
-/**
- * 实现 fs.ensureFileSync 函数
- *
- * @param fs
- * @param path
- * @param filePath
- */
-export declare const ensureFileSync: (fs: any, path: any, filePath: string) => void;
-/**
- * 确保目录存在
- *
- * @param fs
- * @param dir
- */
-export declare const ensureFolderSync: (fs: any, dir: string) => void;
-/**
- * 同步读取 JSON 文件的方法
- *
- * @param fs - fs 模块
- * @param filePath - JSON 文件路径
- * @returns  - JSON 文件内容转换后的对象，如果出错则返回空对象 {}
- */
-export declare const readJSONSync: (fs: any, filePath: string) => any;

package/dist/src/utils/os/index.d.ts

@@ -1,3 +0,0 @@
-export type Platform = "darwin" | "win32" | "win10" | "linux" | "wsl";
-declare const getCurrentPlatform: () => Platform;
-export { getCurrentPlatform };

package/dist/src/utils/os/is-docker/index.d.ts

@@ -1,2 +0,0 @@
-declare const isDocker: () => boolean;
-export { isDocker };

package/dist/src/utils/os/is-inside-container/index.d.ts

@@ -1 +0,0 @@
-export default function isInsideContainer(): boolean;

package/dist/src/utils/os/is-wsl/index.d.ts

@@ -1,2 +0,0 @@
-declare const isWsl: () => boolean;
-export { isWsl };

package/dist/src/utils/picgoEventBus.d.ts

@@ -1,4 +0,0 @@
-import { EventEmitter } from './nodePolyfill';
-
-declare const picgoEventBus: EventEmitter<[never]>;
-export { picgoEventBus };

package/dist/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import('vite').UserConfig;
-export default _default;