universal-picgo 1.12.1 → 2.0.1

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "universal-picgo",
-  "version": "1.12.1",
+  "version": "2.0.1",
   "type": "module",
   "description": "picgo lib for node, browser and electron",
   "main": "./dist/index.js",
@@ -28,7 +28,6 @@
     "@terwer/eslint-config-custom": "^1.3.6",
     "@terwer/vite-config-custom": "^0.7.6",
     "@types/mime": "^4.0.0",
-    "@types/mime-types": "^2.1.4",
     "vite-plugin-node-polyfills": "^0.22.0"
   },
   "dependencies": {
@@ -38,17 +37,15 @@
     "@smithy/protocol-http": "^4.0.0",
     "@smithy/querystring-builder": "^3.0.0",
     "@smithy/fetch-http-handler": "^3.0.1",
-    "@picgo/i18n": "^1.0.0",
-    "ali-oss": "^6.20.0",
     "axios": "^1.6.8",
     "dayjs": "^1.11.11",
+    "hash.js": "^1.1.7",
+    "js-md5": "^0.8.3",
     "js-yaml": "^4.1.0",
     "mime": "^4.0.3",
-    "mime-types": "^2.1.35",
     "queue": "^7.0.0",
     "universal-picgo-store": "workspace:*",
-    "zhi-lib-base": "^0.8.0",
-    "file-type": "^16.2.0"
+    "zhi-lib-base": "^0.8.0"
   },
   "publishConfig": {
     "access": "public"

package/dist/src/core/UniversalPicGo.d.ts

@@ -1,6 +1,6 @@
 import { PicGoRequestWrapper } from '../lib/PicGoRequest';
 import { PluginHandler } from '../lib/PluginHandler';
-import { IHelper, II18nManager, IImgInfo, IPicGo, IPicGoPlugin, IPicGoPluginInterface, IPluginLoader, IStringKeyMap } from '../types';
+import { IConfig, IHelper, II18nManager, IImgInfo, IPicGo, IPicGoPlugin, IPicGoPluginInterface, IPluginLoader, IStringKeyMap, IUniversalPicGoOptions } from '../types';
 import { EventEmitter } from '../utils/nodePolyfill';
 import { ILogger } from 'zhi-lib-base';
 
@@ -22,9 +22,11 @@ declare class UniversalPicGo extends EventEmitter implements IPicGo {
     i18n: II18nManager;
     VERSION: string;
     private readonly isDev;
+    private readonly usesOptionsObject;
     get pluginLoader(): IPluginLoader;
     getLogger(name?: string): ILogger;
     get request(): PicGoRequestWrapper["PicGoRequest"];
+    constructor(options?: IUniversalPicGoOptions);
     constructor(configPath?: string, pluginBaseDir?: string, zhiNpmPath?: string, isDev?: boolean);
     /**
      * easily mannually load a plugin
@@ -33,11 +35,13 @@ declare class UniversalPicGo extends EventEmitter implements IPicGo {
      */
     use(plugin: IPicGoPlugin, name?: string): IPicGoPluginInterface;
     getConfig<T>(name?: string, defaultValue?: any): T;
+    reloadConfig(): IConfig;
     saveConfig(config: IStringKeyMap<any>): void;
     removeConfig(key: string, propName: string): void;
     setConfig(config: IStringKeyMap<any>): void;
     unsetConfig(key: string, propName: string): void;
     upload(input?: any[]): Promise<IImgInfo[] | Error>;
+    private normalizeOptions;
     private getDefautBaseDir;
     private initConfigPath;
     private initZhiNpmPath;

package/dist/src/core/UniversalPicGo.spec.d.ts

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

package/dist/src/db/config/index.d.ts

@@ -11,6 +11,13 @@ declare class ConfigDb implements IPicgoDb<IConfig> {
             current: string;
         };
         picgoPlugins: {};
+        siyuan: {
+            waitTimeout: number;
+            retryTimes: number;
+            autoUpload: boolean;
+            replaceLink: boolean;
+            txtImageSwitch: boolean;
+        };
     };
     constructor(ctx: IPicGo);
     read(flush?: boolean): IJSON;

package/dist/src/db/config/index.spec.d.ts

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

package/dist/src/headless/UniversalPicGoHeadlessManager.d.ts

@@ -0,0 +1,24 @@
+import { IPicGoHeadlessManager, PicGoHeadlessManagerOptions, PicGoHeadlessSaveUploaderConfigOptions, PicGoUploaderConfigSchema, PicGoUploaderListItem, PicGoUploaderSchemaAuditResult, PicGoValidationResult } from './types';
+import { IConfig, IImgInfo, IPicGo } from '../types';
+
+declare class UniversalPicGoHeadlessManager implements IPicGoHeadlessManager {
+    private readonly ctx;
+    constructor(options?: PicGoHeadlessManagerOptions);
+    getContext(): IPicGo;
+    getConfig(): IConfig;
+    getCurrentUploader(): string;
+    setCurrentUploader(uploaderId: string): PicGoValidationResult;
+    listUploaders(): PicGoUploaderListItem[];
+    getUploaderSchema(uploaderId: string): PicGoUploaderConfigSchema;
+    getUploaderConfig<T extends Record<string, unknown> = Record<string, unknown>>(uploaderId: string): T;
+    validateUploaderConfig(uploaderId: string, config: Record<string, unknown>): PicGoValidationResult;
+    saveUploaderConfig(uploaderId: string, config: Record<string, unknown>, options?: PicGoHeadlessSaveUploaderConfigOptions): PicGoValidationResult;
+    auditUploaderSchemas(): PicGoUploaderSchemaAuditResult;
+    upload(input?: any[]): Promise<IImgInfo[]>;
+    private hasUploader;
+    private withSchemaDefaults;
+    private unknownUploaderResult;
+    private unknownUploaderError;
+}
+declare const createPicGoHeadlessManager: (options?: PicGoHeadlessManagerOptions) => UniversalPicGoHeadlessManager;
+export { UniversalPicGoHeadlessManager, createPicGoHeadlessManager };

package/dist/src/headless/UniversalPicGoHeadlessManager.spec.d.ts

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

package/dist/src/headless/index.d.ts

@@ -0,0 +1,3 @@
+export { UniversalPicGoHeadlessManager, createPicGoHeadlessManager } from './UniversalPicGoHeadlessManager';
+export { BUILT_IN_UPLOADER_IDS, auditBuiltInUploaderSchemas, getPicGoUploaderSchema, isBuiltInUploaderId, listPicGoUploaders, type BuiltInUploaderId, } from './uploaderSchemas';
+export { PICGO_HEADLESS_ERROR_CODES, PicGoHeadlessError, type IPicGoHeadlessManager, type PicGoHeadlessErrorCode, type PicGoHeadlessErrorInput, type PicGoHeadlessManagerOptions, type PicGoHeadlessSaveUploaderConfigOptions, type PicGoUploaderConfigSchema, type PicGoUploaderListItem, type PicGoUploaderSchemaAuditResult, type PicGoUploaderSchemaChoice, type PicGoUploaderSchemaField, type PicGoUploaderSchemaFieldType, type PicGoValidationFieldError, type PicGoValidationResult, } from './types';

package/dist/src/headless/types.d.ts

@@ -0,0 +1,116 @@
+import { IConfig, IImgInfo, IPicGo, IUniversalPicGoOptions } from '../types';
+
+export declare const PICGO_HEADLESS_ERROR_CODES: {
+    readonly UNKNOWN_UPLOADER: "UNKNOWN_UPLOADER";
+    readonly SCHEMA_UNAVAILABLE: "SCHEMA_UNAVAILABLE";
+    readonly UNSUPPORTED_SCHEMA_FIELD: "UNSUPPORTED_SCHEMA_FIELD";
+    readonly MISSING_REQUIRED_FIELD: "MISSING_REQUIRED_FIELD";
+    readonly INVALID_FIELD_TYPE: "INVALID_FIELD_TYPE";
+    readonly INVALID_FIELD_CHOICE: "INVALID_FIELD_CHOICE";
+    readonly VALIDATION_FAILED: "VALIDATION_FAILED";
+    readonly UPLOAD_FAILED: "UPLOAD_FAILED";
+};
+export type PicGoHeadlessErrorCode = (typeof PICGO_HEADLESS_ERROR_CODES)[keyof typeof PICGO_HEADLESS_ERROR_CODES];
+export type PicGoUploaderSchemaFieldType = "input" | "password" | "confirm" | "list";
+export interface PicGoUploaderSchemaChoice {
+    label: string;
+    value: string;
+}
+export interface PicGoUploaderListItem {
+    id: string;
+    name: string;
+    builtin: boolean;
+    schemaAvailable: boolean;
+}
+export interface PicGoUploaderSchemaField {
+    name: string;
+    type: PicGoUploaderSchemaFieldType;
+    label?: string;
+    alias?: string;
+    message?: string;
+    required: boolean;
+    default?: unknown;
+    valuePath: string;
+    sensitive: boolean;
+    choices?: PicGoUploaderSchemaChoice[];
+}
+export interface PicGoUploaderConfigSchema {
+    id: string;
+    name: string;
+    builtin: boolean;
+    fields: PicGoUploaderSchemaField[];
+}
+export interface PicGoValidationFieldError {
+    code: PicGoHeadlessErrorCode;
+    uploaderId: string;
+    field?: string;
+    message: string;
+}
+export interface PicGoValidationResult {
+    ok: boolean;
+    uploaderId: string;
+    errors: PicGoValidationFieldError[];
+}
+export interface PicGoUploaderSchemaAuditResult {
+    ok: boolean;
+    errors: PicGoValidationFieldError[];
+}
+export interface PicGoHeadlessManagerOptions extends IUniversalPicGoOptions {
+    /**
+     * Reuse an already initialized PicGo context. When provided, path options are
+     * ignored and no new UniversalPicGo instance is created.
+     */
+    picgo?: IPicGo;
+}
+export interface PicGoHeadlessSaveUploaderConfigOptions {
+    /**
+     * Also make this uploader the PicGo current uploader after a successful save.
+     */
+    setCurrent?: boolean;
+    /**
+     * Validate with the public schema before persisting. Defaults to true.
+     */
+    validate?: boolean;
+    /**
+     * Documented raw escape hatch for advanced callers. When true, validation is
+     * skipped but the write is still scoped to the target uploader section.
+     */
+    unsafeRaw?: boolean;
+}
+export interface IPicGoHeadlessManager {
+    getContext(): IPicGo;
+    getConfig(): IConfig;
+    getCurrentUploader(): string;
+    setCurrentUploader(uploaderId: string): PicGoValidationResult;
+    listUploaders(): PicGoUploaderListItem[];
+    getUploaderSchema(uploaderId: string): PicGoUploaderConfigSchema;
+    getUploaderConfig<T extends Record<string, unknown> = Record<string, unknown>>(uploaderId: string): T;
+    validateUploaderConfig(uploaderId: string, config: Record<string, unknown>): PicGoValidationResult;
+    saveUploaderConfig(uploaderId: string, config: Record<string, unknown>, options?: PicGoHeadlessSaveUploaderConfigOptions): PicGoValidationResult;
+    auditUploaderSchemas(): PicGoUploaderSchemaAuditResult;
+    upload(input?: any[]): Promise<IImgInfo[]>;
+}
+export interface PicGoHeadlessErrorInput {
+    code: PicGoHeadlessErrorCode;
+    message: string;
+    uploaderId?: string;
+    field?: string;
+    errors?: PicGoValidationFieldError[];
+    cause?: unknown;
+}
+export declare class PicGoHeadlessError extends Error {
+    readonly code: PicGoHeadlessErrorCode;
+    readonly uploaderId?: string;
+    readonly field?: string;
+    readonly errors?: PicGoValidationFieldError[];
+    readonly cause?: unknown;
+    constructor(input: PicGoHeadlessErrorInput);
+    toJSON(): {
+        name: string;
+        code: PicGoHeadlessErrorCode;
+        message: string;
+        uploaderId: string | undefined;
+        field: string | undefined;
+        errors: PicGoValidationFieldError[] | undefined;
+    };
+}

package/dist/src/headless/uploaderSchemas.d.ts

@@ -0,0 +1,9 @@
+import { PicGoUploaderConfigSchema, PicGoUploaderListItem, PicGoUploaderSchemaAuditResult } from './types';
+import { IPicGo } from '../types';
+
+export declare const BUILT_IN_UPLOADER_IDS: readonly ["github", "gitlab", "aliyun", "tcyun", "qiniu", "upyun", "smms", "imgur", "awss3", "lsky"];
+export type BuiltInUploaderId = (typeof BUILT_IN_UPLOADER_IDS)[number];
+export declare const isBuiltInUploaderId: (uploaderId: string) => uploaderId is "smms" | "github" | "gitlab" | "aliyun" | "tcyun" | "qiniu" | "upyun" | "imgur" | "awss3" | "lsky";
+export declare const listPicGoUploaders: (ctx: IPicGo) => PicGoUploaderListItem[];
+export declare const getPicGoUploaderSchema: (ctx: IPicGo, uploaderId: string) => PicGoUploaderConfigSchema | undefined;
+export declare const auditBuiltInUploaderSchemas: (ctx: IPicGo) => PicGoUploaderSchemaAuditResult;

package/dist/src/i18n/simpleI18n.d.ts

@@ -0,0 +1,19 @@
+import { ILocale } from '../types';
+
+export declare class ObjectAdapter {
+    private locales;
+    constructor(locales: Record<string, ILocale>);
+    getLocale(language: string): ILocale;
+    setLocale(language: string, locales: ILocale): void;
+}
+export declare class I18n {
+    private readonly adapter;
+    private defaultLanguage;
+    private currentLanguage;
+    constructor(options: {
+        adapter: ObjectAdapter;
+        defaultLanguage: string;
+    });
+    setLanguage(language: string): void;
+    translate<T extends string>(phrase: T, args?: Record<string, string>): string | undefined;
+}

package/dist/src/index.d.ts

@@ -1,5 +1,8 @@
+import { UniversalPicGoHeadlessManager, createPicGoHeadlessManager } from './headless';
+import { isElectronRuntime, isPicGoPluginPackageName, isThirdPartyPluginRuntimeAvailable } from './utils/pluginRuntime';
+import { deepMerge, getByPath, setByPath, unsetByPath } from './utils/pathObject';
 import { calculateMD5, isFileOrBlob, isSiyuanProxyAvailable } from './utils/common';
-import { IConfig, IExternalPicgoConfig, IImgInfo, IPicBedType, IPicGo, IPicgoDb, IPicGoPlugin, IPluginConfig, IUploaderConfigItem, IUploaderConfigListItem } from './types';
+import { IConfig, IExternalPicgoConfig, IImgInfo, IPicBedType, IPicGo, IPicgoDb, IPicGoPlugin, IPluginConfig, IUniversalPicGoOptions, IUploaderConfigItem, IUploaderConfigListItem } from './types';
 import { IBusEvent, PicgoTypeEnum } from './utils/enums';
 import { currentWin, hasNodeEnv, parentWin, win } from 'universal-picgo-store';
 import { picgoEventBus } from './utils/picgoEventBus';
@@ -10,8 +13,12 @@ import { ExternalPicgo } from './core/ExternalPicgo';
 import { UniversalPicGo } from './core/UniversalPicGo';
 
 export { UniversalPicGo, ExternalPicgo, picgoEventBus };
+export { UniversalPicGoHeadlessManager, createPicGoHeadlessManager };
 export { ConfigDb, PluginLoaderDb, ExternalPicgoConfigDb };
 export { PicgoTypeEnum, IBusEvent };
 export { isFileOrBlob, calculateMD5, isSiyuanProxyAvailable };
+export { deepMerge, getByPath, setByPath, unsetByPath };
+export { isElectronRuntime, isPicGoPluginPackageName, isThirdPartyPluginRuntimeAvailable };
 export { win, currentWin, parentWin, hasNodeEnv };
-export { type IPicGo, type IImgInfo, type IPicgoDb, type IConfig, type IExternalPicgoConfig, type IPicBedType, type IUploaderConfigItem, type IUploaderConfigListItem, type IPluginConfig, type IPicGoPlugin, };
+export { type IPicGo, type IImgInfo, type IPicgoDb, type IConfig, type IExternalPicgoConfig, type IPicBedType, type IUploaderConfigItem, type IUploaderConfigListItem, type IPluginConfig, type IPicGoPlugin, type IUniversalPicGoOptions, };
+export { BUILT_IN_UPLOADER_IDS, PICGO_HEADLESS_ERROR_CODES, PicGoHeadlessError, auditBuiltInUploaderSchemas, getPicGoUploaderSchema, isBuiltInUploaderId, listPicGoUploaders, type BuiltInUploaderId, type IPicGoHeadlessManager, type PicGoHeadlessErrorCode, type PicGoHeadlessErrorInput, type PicGoHeadlessManagerOptions, type PicGoHeadlessSaveUploaderConfigOptions, type PicGoUploaderConfigSchema, type PicGoUploaderListItem, type PicGoUploaderSchemaAuditResult, type PicGoUploaderSchemaChoice, type PicGoUploaderSchemaField, type PicGoUploaderSchemaFieldType, type PicGoValidationFieldError, type PicGoValidationResult, } from './headless';

package/dist/src/lib/PluginLoader.d.ts

@@ -6,7 +6,7 @@ import { IPicGo, IPicGoPlugin, IPicGoPluginInterface, IPluginLoader } from '../t
 export declare class PluginLoader implements IPluginLoader {
     private readonly ctx;
     private readonly logger;
-    private db;
+    private db?;
     private list;
     private readonly fullList;
     private readonly pluginMap;

package/dist/src/plugins/uploader/aliyun/node.d.ts

@@ -1,4 +1 @@
-import { IPicGo } from '../../../types';
-
-declare const handleNode: (ctx: IPicGo) => Promise<IPicGo>;
-export { handleNode };
+export { handleWeb as handleNode } from './web';

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

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

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

@@ -0,0 +1,7 @@
+import { Buffer } from './nodePolyfill';
+
+type HashAlgorithm = "md5" | "sha1" | "sha256";
+type DigestEncoding = "hex" | "base64" | undefined;
+export declare function digestHash(input: string | Buffer | Uint8Array, algorithm: HashAlgorithm, encoding: DigestEncoding): string;
+export declare function digestHmacSha1(key: string | Buffer | Uint8Array, value: string | Buffer | Uint8Array, encoding: DigestEncoding): string | Buffer;
+export {};

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

@@ -0,0 +1 @@
+export declare function lookupMimeType(fileName?: string): string | undefined;

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

@@ -0,0 +1,4 @@
+export declare function getByPath(obj: any, path?: string, defaultValue?: any): any;
+export declare function setByPath(obj: any, path: string, value: any): void;
+export declare function unsetByPath(obj: any, path: string): boolean;
+export declare function deepMerge<T extends Record<string, any>>(target: T, source: Record<string, any>): T;

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

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

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

@@ -0,0 +1,9 @@
+/**
+ * PicGo 第三方插件依赖 Electron 的本机能力（node_modules、@electron/remote、插件菜单等）。
+ *
+ * v2 配置会在多个运行端共享，但非 Electron 端（浏览器、Docker、publisher 的 web runtime 等）
+ * 不能读取或应用任何第三方插件配置，否则会把本机 PC-only 状态误当成跨端平台能力。
+ */
+export declare const isElectronRuntime: () => boolean;
+export declare const isThirdPartyPluginRuntimeAvailable: () => boolean;
+export declare const isPicGoPluginPackageName: (name: string) => boolean;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "universal-picgo",
-  "version": "1.12.1",
+  "version": "2.0.1",
   "type": "module",
   "description": "picgo lib for node, browser and electron",
   "main": "./dist/index.js",
@@ -21,7 +21,6 @@
     "@terwer/eslint-config-custom": "^1.3.6",
     "@terwer/vite-config-custom": "^0.7.6",
     "@types/mime": "^4.0.0",
-    "@types/mime-types": "^2.1.4",
     "vite-plugin-node-polyfills": "^0.22.0"
   },
   "dependencies": {
@@ -31,17 +30,15 @@
     "@smithy/protocol-http": "^4.0.0",
     "@smithy/querystring-builder": "^3.0.0",
     "@smithy/fetch-http-handler": "^3.0.1",
-    "@picgo/i18n": "^1.0.0",
-    "ali-oss": "^6.20.0",
     "axios": "^1.6.8",
     "dayjs": "^1.11.11",
+    "hash.js": "^1.1.7",
+    "js-md5": "^0.8.3",
     "js-yaml": "^4.1.0",
     "mime": "^4.0.3",
-    "mime-types": "^2.1.35",
     "queue": "^7.0.0",
     "zhi-lib-base": "^0.8.0",
-    "file-type": "^16.2.0",
-    "universal-picgo-store": "1.12.1"
+    "universal-picgo-store": "2.0.1"
   },
   "publishConfig": {
     "access": "public"