picgo-plugin-cloudflare-imgbed 0.0.3 → 0.3.0

package/README.md

@@ -2,11 +2,11 @@
 
 Third Party PicGo Uploader For MarSeventh/CloudFlare-ImgBed
 
+**🚧 only support picgo-cli, no GUI support now.**
+
 ## Workflow
 Rename the image in format `yyyyMMddHHmmssSSS` , then upload the image according to your configuration.
 
-**Cli only til now.**
-
 ## Installation
 ```bash
 picgo install cloudflare-imgbed
@@ -16,20 +16,29 @@ picgo install cloudflare-imgbed
 ```bash
 picgo set uploader
 ```
-
-![set-uploader](./doc/set-uploader.png)
-
 - **Base URL**: `https://your-imgbed.com`
 - **Auth Code**: you can set in `https://your-imgbed.com/systemConfig#security`, leave empty if not set.
-- **Path**: relative path, leave empty for root(`/`), it's like  `https://your-imgbed.com/file/${Path}/202311251618630.webp` in links.
-- **Upload Name Type**: how the backend rename your image.
-    - origin(default): no rename, like `yyyyMMddHHmmssSSS.webp`
-    - default: add index in front, like `11110000_yyyyMMddHHmmssSSS.webp`
-    - short: encoding like short link, like `8P2yDGMl.webp`
-    - index: only index, like `11110000.webp`
+- **Upload Folder**: relative path, leave empty for root(`/`), it's like  `https://your-imgbed.com/file/${Upload Folder}/202311251618630.webp` in links.
+- **Upload Name Type**: how the backend renames your image. Since the plugin already renames images with a timestamp, the default is set to `origin` (no further rename by the backend).
+    - `origin` (plugin default): keep the uploaded filename as-is, e.g. `yyyyMMddHHmmssSSS.webp`
+    - `default`: add an index prefix, e.g. `11110000_yyyyMMddHHmmssSSS.webp`
+    - `short`: encode like a short link, e.g. `8P2yDGMl.webp`
+    - `index`: index only, e.g. `11110000.webp`
+- **Upload Channel**: storage channel for uploading images (optional, defaults to `server-default` which uses server configuration).
+    - `server-default`: use the server's default channel configuration
+    - `telegram`: upload to Telegram
+    - `cfr2`: upload to Cloudflare R2
+    - `s3`: upload to S3-compatible storage
+    - `discord`: upload to Discord
+    - `huggingface`: upload to Hugging Face
+- **Channel Name**: specific channel name (required when `Upload Channel` is not `server-default`, visit `https://your-imgbed.com/api/channels` for more details).
+
 ## Update
 ```bash
 picgo update cloudflare-imgbed
 ```
 
-## 
+## Parameters Not Implemented
+- **severCompress**: "false" option only can be used in Telegram upload channel, default option is true on server side.
+- **autoRetry**: AutoRetry is enabled by default on server side, so it's not necessary to add this option to the plugin.
+- **returnFormat**: Always return full link, I don't think someone need the /file/xxx format.

package/dist/index.js

@@ -27,9 +27,14 @@ module.exports = (ctx) => {
                 const params = new URLSearchParams();
                 if (config.authCode)
                     params.set('authCode', config.authCode);
-                if (config.path)
-                    params.set('uploadFolder', config.path);
+                if (config.uploadFolder)
+                    params.set('uploadFolder', config.uploadFolder);
                 params.set('uploadNameType', (_a = config.uploadNameType) !== null && _a !== void 0 ? _a : 'origin');
+                if (config.uploadChannel && config.uploadChannel !== 'server-default') {
+                    params.set('uploadChannel', config.uploadChannel);
+                    if (config.channelName)
+                        params.set('channelName', config.channelName);
+                }
                 const query = params.toString();
                 const uploadUrl = `${baseUrl}/upload${query ? '?' + query : ''}`;
                 for (const img of ctx.output) {
@@ -61,7 +66,7 @@ module.exports = (ctx) => {
                 return ctx;
             },
             config(ctx) {
-                var _a, _b, _c, _d, _e;
+                var _a, _b, _c, _d, _e, _f, _g;
                 const savedConfig = (_a = ctx.getConfig('picBed.cloudflare-imgbed')) !== null && _a !== void 0 ? _a : {};
                 return [
                     {
@@ -81,21 +86,39 @@ module.exports = (ctx) => {
                         alias: 'Auth Code'
                     },
                     {
-                        name: 'path',
+                        name: 'uploadFolder',
                         type: 'input',
-                        default: (_d = savedConfig.path) !== null && _d !== void 0 ? _d : '',
+                        default: (_d = savedConfig.uploadFolder) !== null && _d !== void 0 ? _d : '',
                         required: false,
-                        message: 'Path, e.g. images, blog/images (leave empty for root)',
-                        alias: 'Upload Path'
+                        message: 'Upload folder, e.g. images, blog/images (leave empty for root)',
+                        alias: 'Upload Folder'
                     },
                     {
                         name: 'uploadNameType',
                         type: 'list',
                         default: (_e = savedConfig.uploadNameType) !== null && _e !== void 0 ? _e : 'origin',
                         required: false,
-                        message: 'Upload Name Type',
+                        message: 'How backend renames image. origin=keep name (plugin default), default=add index prefix, short=short link, index=index only. Check README in https://github.com/MegaSuite/picgo-plugin-cloudflare-imgbed for more details. ',
                         choices: ['origin', 'default', 'index', 'short'],
                         alias: 'Upload Name Type'
+                    },
+                    {
+                        name: 'uploadChannel',
+                        type: 'list',
+                        default: (_f = savedConfig.uploadChannel) !== null && _f !== void 0 ? _f : 'server-default',
+                        required: false,
+                        message: 'Upload storage channel (server-default uses server config)',
+                        choices: ['server-default', 'telegram', 'cfr2', 's3', 'discord', 'huggingface'],
+                        alias: 'Upload Channel'
+                    },
+                    {
+                        name: 'channelName',
+                        type: 'input',
+                        default: (_g = savedConfig.channelName) !== null && _g !== void 0 ? _g : '',
+                        required: false,
+                        message: 'Specific channel name (used when uploadChannel is not server-default)',
+                        alias: 'Channel Name',
+                        when: (answers) => answers.uploadChannel && answers.uploadChannel !== 'server-default'
                     }
                 ];
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picgo-plugin-cloudflare-imgbed",
-  "version": "0.0.3",
+  "version": "0.3.0",
   "description": "Third Party PicGo Uploader For MarSeventh/CloudFlare-ImgBed",
   "main": "dist/index.js",
   "publishConfig": {
@@ -12,9 +12,9 @@
     "build": "tsc -p .",
     "dev": "tsc -w -p .",
     "lint": "eslint src",
-    "patch": "npm version patch && git push origin master && git push origin --tags",
-    "minor": "npm version minor && git push origin master && git push origin --tags",
-    "major": "npm version major && git push origin master && git push origin --tags"
+    "patch": "npm version patch && git push origin main && git push origin --tags",
+    "minor": "npm version minor && git push origin main && git push origin --tags",
+    "major": "npm version major && git push origin main && git push origin --tags"
   },
   "keywords": [
     "picgo",