piclist 1.9.13 → 2.0.0

package/dist/types/oldRequest.d.ts

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

package/dist/utils/common.d.ts

@@ -1,119 +1,42 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import sharp from 'sharp';
-import crypto from 'crypto';
-import { IImgSize, IPathTransformedImgInfo, IPluginNameType, ILogger, IPicGo, IBuildInCompressOptions, IBuildInWaterMarkOptions } from '../types';
-export declare function randomStringGenerator(length: number): string;
-export declare function renameFileNameWithTimestamp(oldName: string): string;
-export declare function renameFileNameWithRandomString(oldName: string, length?: number): string;
-export declare function renameFileNameWithCustomString(oldName: string, customFormat: string, affixFileName?: string, fileBuffer?: crypto.BinaryLike): string;
-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 function AddWatermark(img: Buffer, watermarkType: 'text' | 'image', defaultWatermarkFontPath: string, isFullScreenWatermark?: boolean, watermarkDegree?: number, text?: string, watermarkFontPath?: string, watermarkScaleRatio?: number, watermarkColor?: string, watermarkImagePath?: string, position?: sharp.Gravity): Promise<Buffer>;
-export declare function imageAddWaterMark(img: Buffer, options: IBuildInWaterMarkOptions, defaultWatermarkFontPath: string, logger: ILogger): Promise<Buffer>;
-export declare function imageCompress(img: Buffer, options: IBuildInCompressOptions, rawFormat: string, logger: ILogger): Promise<Buffer>;
-export declare function getConvertedFormat(options: IBuildInCompressOptions | undefined, rawFormat: string): string;
-export declare const isNeedAddWatermark: (watermarkOptions: IBuildInWaterMarkOptions | undefined, fileExt: string) => boolean;
-export declare const isNeedCompress: (compressOptions: IBuildInCompressOptions | undefined, fileExt: string) => boolean;
-export declare const removeExif: (img: Buffer, fileExt: string) => Promise<Buffer>;
+import crypto from 'node:crypto';
+import sharp from 'sharp';
+import type { IBuildInCompressOptions, IBuildInWaterMarkOptions, IImgSize, ILogger, IPathTransformedImgInfo, IPicGo, IPluginNameType } from '../types';
+export declare function randomStringGenerator(length: number): string;
+export declare function renameFileNameWithTimestamp(oldName: string): string;
+export declare function renameFileNameWithRandomString(oldName: string, length?: number): string;
+export declare function renameFileNameWithCustomString(oldName: string, customFormat: string, affixFileName?: string, fileBuffer?: crypto.BinaryLike): string;
+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>;
+export declare const getPluginNameType: (name: string) => IPluginNameType;
+export declare const isSimpleName: (nameOrPath: string) => boolean;
+export declare const handleStreamlinePluginName: (name: string) => string;
+export declare const handleCompletePluginName: (name: string, scope?: string) => string;
+export declare const getProcessPluginName: (nameOrPath: string, logger?: ILogger | Console) => string;
+export declare const getNormalPluginName: (nameOrPath: string, logger?: ILogger | Console) => string;
+export declare const handleUnixStylePath: (pathStr: string) => string;
+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;
+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 function AddWatermark(img: Buffer, watermarkType: 'text' | 'image', defaultWatermarkFontPath: string, isFullScreenWatermark?: boolean, watermarkDegree?: number, text?: string, watermarkFontPath?: string, watermarkScaleRatio?: number, watermarkColor?: string, watermarkImagePath?: string, position?: sharp.Gravity, watermarkImageOpacity?: number): Promise<Buffer>;
+export declare function imageAddWaterMark(img: Buffer, options: IBuildInWaterMarkOptions, defaultWatermarkFontPath: string, logger: ILogger): Promise<Buffer>;
+export declare function imageCompress(img: Buffer, options: IBuildInCompressOptions, rawFormat: string, logger: ILogger): Promise<Buffer>;
+export declare function getConvertedFormat(options: IBuildInCompressOptions | undefined, rawFormat: string): string;
+export declare const isNeedAddWatermark: (watermarkOptions: IBuildInWaterMarkOptions | undefined, fileExt: string) => boolean;
+export declare const isNeedCompress: (compressOptions: IBuildInCompressOptions | undefined, fileExt: string) => boolean;
+export declare const removeExif: (img: Buffer, fileExt: string) => Promise<Buffer>;

package/dist/utils/createContext.d.ts

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

@@ -1,15 +1,17 @@
-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;
+interface IJSON {
+    [propsName: string]: string | number | IJSON;
+}
+import { IConfig, IPicGo } from '../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;

package/dist/utils/enum.d.ts

@@ -1,27 +1,27 @@
-export declare enum ILogType {
-    success = "success",
-    info = "info",
-    warn = "warn",
-    error = "error"
-}
-/**
- * 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"
-}
+export declare enum ILogType {
+    success = "success",
+    info = "info",
+    warn = "warn",
+    error = "error"
+}
+/**
+ * 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"
+}

package/dist/utils/eventBus.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-declare const eventBus: EventEmitter;
-export { eventBus };
+import { EventEmitter } from 'node:events';
+declare const eventBus: EventEmitter<[never]>;
+export { eventBus };

package/dist/utils/getClipboardImage.d.ts

@@ -1,4 +1,4 @@
-import { IPicGo, IClipboardImage } from '../types';
-export type Platform = 'darwin' | 'win32' | 'win10' | 'linux' | 'wsl';
-declare const getClipboardImage: (ctx: IPicGo) => Promise<IClipboardImage>;
-export default getClipboardImage;
+import { IClipboardImage, IPicGo } from '../types';
+export type Platform = 'darwin' | 'win32' | 'win10' | 'linux' | 'wsl';
+declare const getClipboardImage: (ctx: IPicGo) => Promise<IClipboardImage>;
+export default getClipboardImage;

package/dist/utils/sshClient.d.ts

@@ -1,16 +1,16 @@
-import { ISftpPlistConfig } from '../types';
-declare class SSHClient {
-    private static instance;
-    private client;
-    isConnected: boolean;
-    private constructor();
-    static getInstance(): SSHClient;
-    private static changeWinStylePathToUnix;
-    connect(config: ISftpPlistConfig): Promise<void>;
-    upload(local: string, remote: string, config: ISftpPlistConfig): Promise<void>;
-    private mkdir;
-    chown(remote: string, user: string, group?: string): Promise<void>;
-    private exec;
-    close(): void;
-}
-export default SSHClient;
+import type { ISftpPlistConfig } from '../types';
+declare class SSHClient {
+    private static instance;
+    private client;
+    isConnected: boolean;
+    private constructor();
+    static getInstance(): SSHClient;
+    private static changeWinStylePathToUnix;
+    connect(config: ISftpPlistConfig): Promise<void>;
+    upload(local: string, remote: string, config: ISftpPlistConfig): Promise<void>;
+    private mkdir;
+    chown(remote: string, user: string, group?: string): Promise<void>;
+    private exec;
+    close(): void;
+}
+export default SSHClient;

package/dist/utils/static.d.ts

@@ -1 +1 @@
-export declare const CLIPBOARD_IMAGE_FOLDER = "piclist-clipboard-images";
+export declare const CLIPBOARD_IMAGE_FOLDER = "piclist-clipboard-images";

package/docker-compose.yaml

@@ -1,12 +1,12 @@
-version: '3.3'
-
-services:
-  node:
-    image: 'kuingsmile/piclist:latest'
-    container_name: piclist
-    restart: always
-    ports:
-      - 36677:36677
-    volumes:
-      - './piclist:/root/.piclist'
+version: '3.3'
+
+services:
+  node:
+    image: 'kuingsmile/piclist:latest'
+    container_name: piclist
+    restart: always
+    ports:
+      - 36677:36677
+    volumes:
+      - './piclist:/root/.piclist'
     command: node /usr/local/bin/picgo-server -k piclist123456

package/eslint.config.js

@@ -0,0 +1,104 @@
+import eslint from '@eslint/js'
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
+import simpleImportSort from 'eslint-plugin-simple-import-sort'
+import eslintPluginUnicorn from 'eslint-plugin-unicorn'
+import globals from 'globals'
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  {
+    files: [
+      './src/*.{ts,tsx,cts,mts,js,cjs,mjs}',
+      './scripts/*.{ts,js,mjs}',
+      './test/*.{ts,js,mjs}',
+      './bin/picgo',
+      './bin/picgo-server'
+    ]
+  },
+  {
+    ignores: ['**/node_modules/**', '**/dist/**', '**/webpack.config.js', 'vitest.workspace.mjs']
+  },
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+  ...tseslint.configs.stylistic,
+  {
+    plugins: {
+      'simple-import-sort': simpleImportSort,
+      unicorn: eslintPluginUnicorn
+    },
+    rules: {
+      'simple-import-sort/imports': 'error',
+      'simple-import-sort/exports': 'error'
+    }
+  },
+  {
+    languageOptions: {
+      parserOptions: {
+        warnOnUnsupportedTypeScriptVersion: false
+      },
+      globals: globals.node
+    }
+  },
+  {
+    rules: {
+      eqeqeq: 'error',
+      'no-caller': 'error',
+      'no-constant-condition': ['error', { checkLoops: false }],
+      'no-eval': 'error',
+      'no-extra-bind': 'error',
+      'no-new-func': 'error',
+      'no-new-wrappers': 'error',
+      'no-throw-literal': 'error',
+      'no-undef-init': 'error',
+      'no-var': 'error',
+      'object-shorthand': 'error',
+      'prefer-const': 'error',
+      'prefer-object-spread': 'error',
+      'unicode-bom': ['error', 'never'],
+      // Enabled in eslint:recommended, but not applicable here
+      'no-extra-boolean-cast': 'off',
+      'no-case-declarations': 'off',
+      'no-cond-assign': 'off',
+      'no-control-regex': 'off',
+      'no-inner-declarations': 'off',
+      'no-empty': 'off',
+
+      // @typescript-eslint/eslint-plugin
+      'no-unused-expressions': 'off',
+      '@typescript-eslint/no-unused-expressions': 'off',
+      '@typescript-eslint/ban-ts-comment': 'off',
+      '@typescript-eslint/class-literal-property-style': 'off',
+      '@typescript-eslint/consistent-indexed-object-style': 'off',
+      '@typescript-eslint/consistent-generic-constructors': 'off',
+      '@typescript-eslint/no-duplicate-enum-values': 'off',
+      '@typescript-eslint/no-empty-function': 'off',
+      '@typescript-eslint/no-namespace': 'off',
+      '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
+      '@typescript-eslint/no-var-requires': 'off',
+      '@typescript-eslint/no-empty-interface': 'off',
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-empty-object-type': 'off', // {} is a totally useful and valid type.
+      '@typescript-eslint/no-require-imports': 'off',
+      '@typescript-eslint/no-unused-vars': 'off',
+      '@typescript-eslint/no-inferrable-types': 'off',
+      // Pending https://github.com/typescript-eslint/typescript-eslint/issues/4820
+      '@typescript-eslint/prefer-optional-chain': 'off',
+      'unicorn/prefer-node-protocol': 'error'
+    }
+  },
+  {
+    files: ['**/*.mjs', '**/*.mts'],
+    rules: {
+      // These globals don't exist outside of CJS files.
+      'no-restricted-globals': [
+        'error',
+        { name: '__filename' },
+        { name: '__dirname' },
+        { name: 'require' },
+        { name: 'module' },
+        { name: 'exports' }
+      ]
+    }
+  },
+  eslintPluginPrettierRecommended
+)