picgo-plugin-s3 1.1.4 → 1.2.1

package/.eslintrc

@@ -0,0 +1,21 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier"
+  ],
+  "plugins": ["prettier", "@typescript-eslint"],
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "rules": {
+    "prettier/prettier": [
+      "error",
+      {
+        "semi": false
+      }
+    ]
+  }
+}

package/README.md

@@ -19,18 +19,19 @@ GUI 直接搜索 _S3_ 下载即可，Core 版执行 `picgo add s3` 安装。
 picgo set uploader aws-s3
 ```
 
-| Key               | 说明                          | 例子                               |
-| ----------------- | ----------------------------- | ---------------------------------- |
-| `accessKeyID`     | AWS 凭证 ID                   |                                    |
-| `secretAccessKey` | AWS 凭证密钥                  |                                    |
-| `bucketName`      | S3 桶名称                     | `gallery`                          |
-| `uploadPath`      | 上传路径                      | `{year}/{month}/{fullName}`        |
-| `urlPrefix`       | 最终生成图片 URL 的自定义前缀 | `https://img.example.com/my-blog/` |
-| `endpoint`        | 指定自定义终端节点            | `s3.us-west-2.amazonaws.com`       |
-| `region`          | 指定执行服务请求的区域        | `us-west-1`                        |
-| `pathStyleAccess` | 是否启用 S3 Path style | 默认为 `false`，使用 minio 请设置为 `true` |
-| `rejectUnauthorized` | 是否拒绝无效TLS证书连接 | 默认为 `true`，如上传失败日志显示证书问题可设置为`false`|
-| `acl` | 访问控制列表，上传资源的访问策略 | 默认为 `public-read` |
+| Key                  | 说明                                                                    | 例子                                                     |
+| -------------------- | ----------------------------------------------------------------------- | -------------------------------------------------------- |
+| `accessKeyID`        | AWS 凭证 ID                                                             |                                                          |
+| `secretAccessKey`    | AWS 凭证密钥                                                            |                                                          |
+| `bucketName`         | S3 桶名称                                                               | `gallery`                                                |
+| `uploadPath`         | 上传路径                                                                | `{year}/{month}/{fullName}`                              |
+| `urlPrefix`          | 最终生成图片 URL 的自定义前缀                                           | `https://img.example.com/my-blog/`                       |
+| `endpoint`           | 指定自定义终端节点                                                      | `s3.us-west-2.amazonaws.com`                             |
+| `region`             | 指定执行服务请求的区域                                                  | `us-west-1`                                              |
+| `pathStyleAccess`    | 是否启用 S3 Path style                                                  | 默认为 `false`，使用 minio 请设置为 `true`               |
+| `rejectUnauthorized` | 是否拒绝无效 TLS 证书连接                                               | 默认为 `true`，如上传失败日志显示证书问题可设置为`false` |
+| `bucketEndpoint`     | 提供的 Endpoint 是否针对单个存储桶（如果它针对根 API 端点，则为 false） | 默认为 `false`                                           |
+| `acl`                | 访问控制列表，上传资源的访问策略                                        | 默认为 `public-read`                                     |
 
 **上传路径支持 payload：**
 

package/dist/config.d.ts

@@ -0,0 +1,13 @@
+export interface IS3UserConfig {
+    accessKeyID: string;
+    secretAccessKey: string;
+    bucketName: string;
+    uploadPath: string;
+    region?: string;
+    endpoint?: string;
+    urlPrefix?: string;
+    pathStyleAccess?: boolean;
+    rejectUnauthorized?: boolean;
+    bucketEndpoint?: boolean;
+    acl?: string;
+}

package/dist/config.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import picgo from 'picgo';
+import picgo from "picgo";
 declare const _default: (ctx: picgo) => {
     register: () => void;
 };

package/dist/index.js

@@ -7,117 +7,126 @@ const utils_1 = require("./utils");
 module.exports = (ctx) => {
     const config = (ctx) => {
         const defaultConfig = {
-            accessKeyID: '',
-            secretAccessKey: '',
-            bucketName: '',
-            uploadPath: '{year}/{month}/{md5}.{extName}',
+            accessKeyID: "",
+            secretAccessKey: "",
+            bucketName: "",
+            uploadPath: "{year}/{month}/{md5}.{extName}",
             pathStyleAccess: false,
             rejectUnauthorized: true,
-            acl: 'public-read'
+            bucketEndpoint: false,
+            acl: "public-read",
         };
-        let userConfig = ctx.getConfig('picBed.aws-s3');
+        let userConfig = ctx.getConfig("picBed.aws-s3");
         userConfig = Object.assign(Object.assign({}, defaultConfig), (userConfig || {}));
         return [
             {
-                name: 'accessKeyID',
-                type: 'input',
+                name: "accessKeyID",
+                type: "input",
                 default: userConfig.accessKeyID,
                 required: true,
-                message: 'access key id',
-                alias: '应用密钥 ID'
+                message: "access key id",
+                alias: "应用密钥 ID",
             },
             {
-                name: 'secretAccessKey',
-                type: 'password',
+                name: "secretAccessKey",
+                type: "password",
                 default: userConfig.secretAccessKey,
                 required: true,
-                message: 'secret access key',
-                alias: '应用密钥'
+                message: "secret access key",
+                alias: "应用密钥",
             },
             {
-                name: 'bucketName',
-                type: 'input',
+                name: "bucketName",
+                type: "input",
                 default: userConfig.bucketName,
                 required: true,
-                alias: '桶'
+                alias: "桶",
             },
             {
-                name: 'uploadPath',
-                type: 'input',
+                name: "uploadPath",
+                type: "input",
                 default: userConfig.uploadPath,
                 required: true,
-                alias: '文件路径'
+                alias: "文件路径",
             },
             {
-                name: 'acl',
-                type: 'input',
+                name: "acl",
+                type: "input",
                 default: userConfig.acl,
-                message: '文件访问权限',
+                message: "文件访问权限",
                 required: true,
-                alias: '权限'
+                alias: "权限",
             },
             {
-                name: 'region',
-                type: 'input',
+                name: "region",
+                type: "input",
                 default: userConfig.region,
                 required: false,
-                alias: '地区'
+                alias: "地区",
             },
             {
-                name: 'endpoint',
-                type: 'input',
+                name: "endpoint",
+                type: "input",
                 default: userConfig.endpoint,
                 required: false,
-                alias: '自定义节点'
+                alias: "自定义节点",
             },
             {
-                name: 'urlPrefix',
-                type: 'input',
+                name: "urlPrefix",
+                type: "input",
                 default: userConfig.urlPrefix,
-                message: 'https://img.example.com/bucket-name/',
+                message: "https://img.example.com/bucket-name/",
                 required: false,
-                alias: '自定义域名'
+                alias: "自定义域名",
             },
             {
-                name: 'pathStyleAccess',
-                type: 'confirm',
+                name: "pathStyleAccess",
+                type: "confirm",
                 default: userConfig.pathStyleAccess || false,
-                message: 'enable path-style-access or not',
+                message: "enable path-style-access or not",
                 required: false,
-                alias: 'PathStyleAccess'
+                alias: "PathStyleAccess",
             },
             {
-                name: 'rejectUnauthorized',
-                type: 'confirm',
+                name: "rejectUnauthorized",
+                type: "confirm",
                 default: userConfig.rejectUnauthorized || true,
-                message: '是否拒绝无效TLS证书连接',
+                message: "是否拒绝无效TLS证书连接",
                 required: false,
-                alias: 'rejectUnauthorized'
+                alias: "rejectUnauthorized",
             },
             {
-                name: 'acl',
-                type: 'input',
-                default: userConfig.acl || 'public-read',
-                message: '上传资源的访问策略',
+                name: "bucketEndpoint",
+                type: "confirm",
+                default: userConfig.bucketEndpoint || false,
+                message: "提供的Endpoint是否针对单个存储桶（如果它针对根 API 端点，则为 false）",
                 required: false,
-                alias: 'ACL 访问控制列表'
-            }
+                alias: "bucketEndpoint",
+            },
+            {
+                name: "acl",
+                type: "input",
+                default: userConfig.acl || "public-read",
+                message: "上传资源的访问策略",
+                required: false,
+                alias: "ACL 访问控制列表",
+            },
         ];
     };
     const handle = async (ctx) => {
-        let userConfig = ctx.getConfig('picBed.aws-s3');
+        const userConfig = ctx.getConfig("picBed.aws-s3");
         if (!userConfig) {
             throw new Error("Can't find amazon s3 uploader config");
         }
         if (userConfig.urlPrefix) {
-            userConfig.urlPrefix = userConfig.urlPrefix.replace(/\/?$/, '');
+            userConfig.urlPrefix = userConfig.urlPrefix.replace(/\/?$/, "");
         }
-        const client = uploader_1.default.createS3Client(userConfig.accessKeyID, userConfig.secretAccessKey, userConfig.region, userConfig.endpoint, userConfig.pathStyleAccess, userConfig.rejectUnauthorized);
+        const client = uploader_1.default.createS3Client(userConfig);
         const output = ctx.output;
-        const tasks = output.map((item, idx) => uploader_1.default.createUploadTask(client, userConfig.bucketName, utils_1.formatPath(item, userConfig.uploadPath), item, idx, userConfig.acl));
+        const tasks = output.map((item, idx) => uploader_1.default.createUploadTask(client, userConfig.bucketName, (0, utils_1.formatPath)(item, userConfig.uploadPath), item, idx, userConfig.acl));
         try {
             const results = await Promise.all(tasks);
-            for (let result of results) {
+            for (const result of results) {
                 const { index, url, imgURL } = result;
                 delete output[index].buffer;
                 delete output[index].base64Image;
@@ -131,24 +140,24 @@ module.exports = (ctx) => {
             return ctx;
         }
         catch (err) {
-            ctx.log.error('上传到 Amazon S3 发生错误，请检查配置是否正确');
+            ctx.log.error("上传到 Amazon S3 发生错误，请检查配置是否正确");
             ctx.log.error(err);
-            ctx.emit('notification', {
-                title: 'Amazon S3 上传错误',
-                body: '请检查配置是否正确',
-                text: ''
+            ctx.emit("notification", {
+                title: "Amazon S3 上传错误",
+                body: "请检查配置是否正确",
+                text: "",
             });
             throw err;
         }
     };
     const register = () => {
-        ctx.helper.uploader.register('aws-s3', {
+        ctx.helper.uploader.register("aws-s3", {
             handle,
             config,
-            name: 'Amazon S3'
+            name: "Amazon S3",
         });
     };
     return {
-        register
+        register,
     };
 };

package/dist/uploader.d.ts

@@ -1,12 +1,13 @@
-import AWS from 'aws-sdk';
-import { IImgInfo } from 'picgo/dist/src/types';
+import { S3 } from "aws-sdk";
+import { IImgInfo } from "picgo/dist/src/types";
+import { IS3UserConfig } from "./config";
 export interface IUploadResult {
     url: string;
     imgURL: string;
     index: number;
 }
-declare function createS3Client(accessKeyID: string, secretAccessKey: string, region: string, endpoint: string, pathStyleAccess: boolean, rejectUnauthorized: boolean): AWS.S3;
-declare function createUploadTask(s3: AWS.S3, bucketName: string, path: string, item: IImgInfo, index: number, acl: string): Promise<IUploadResult>;
+declare function createS3Client(opts: IS3UserConfig): S3;
+declare function createUploadTask(s3: S3, bucketName: string, path: string, item: IImgInfo, index: number, acl: string): Promise<IUploadResult>;
 declare const _default: {
     createS3Client: typeof createS3Client;
     createUploadTask: typeof createUploadTask;

package/dist/uploader.js

@@ -3,51 +3,67 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const aws_sdk_1 = __importDefault(require("aws-sdk"));
-const https_1 = __importDefault(require("https"));
+const aws_sdk_1 = require("aws-sdk");
 const utils_1 = require("./utils");
-function createS3Client(accessKeyID, secretAccessKey, region, endpoint, pathStyleAccess, rejectUnauthorized) {
-    const s3 = new aws_sdk_1.default.S3({
-        region,
-        endpoint,
-        accessKeyId: accessKeyID,
-        secretAccessKey: secretAccessKey,
-        s3ForcePathStyle: pathStyleAccess,
+const url_1 = __importDefault(require("url"));
+function createS3Client(opts) {
+    let sslEnabled = true;
+    try {
+        const u = url_1.default.parse(opts.endpoint);
+        sslEnabled = u.protocol === "https:";
+    }
+    catch (_a) {
+        // eslint-disable-next-line no-empty
+    }
+    const http = sslEnabled ? require("https") : require("http");
+    const s3 = new aws_sdk_1.S3({
+        region: opts.region,
+        endpoint: opts.endpoint,
+        accessKeyId: opts.accessKeyID,
+        secretAccessKey: opts.secretAccessKey,
+        s3ForcePathStyle: opts.pathStyleAccess,
+        s3BucketEndpoint: opts.bucketEndpoint,
+        sslEnabled: sslEnabled,
         httpOptions: {
-            agent: new https_1.default.Agent({
-                rejectUnauthorized: rejectUnauthorized,
-            })
-        }
+            agent: new http.Agent({
+                rejectUnauthorized: opts.rejectUnauthorized,
+            }),
+        },
     });
     return s3;
 }
 function createUploadTask(s3, bucketName, path, item, index, acl) {
-    return new Promise(async (resolve, reject) => {
+    return new Promise((resolve, reject) => {
         if (!item.buffer && !item.base64Image) {
-            reject(new Error('undefined image'));
+            reject(new Error("undefined image"));
         }
-        const { body, contentType, contentEncoding } = await utils_1.extractInfo(item);
-        const opts = {
-            Key: path,
-            Bucket: bucketName,
-            ACL: acl,
-            Body: body,
-            ContentType: contentType,
-            ContentEncoding: contentEncoding,
-        };
-        s3.upload(opts)
-            .promise()
-            .then((result) => {
-            resolve({
-                url: result.Location,
-                imgURL: result.Key,
-                index
-            });
+        (0, utils_1.extractInfo)(item)
+            .then(({ body, contentType, contentEncoding }) => {
+            const opts = {
+                Key: path,
+                Bucket: bucketName,
+                ACL: acl,
+                Body: body,
+                ContentType: contentType,
+                ContentEncoding: contentEncoding,
+            };
+            s3.upload(opts)
+                .promise()
+                .then((result) => {
+                resolve({
+                    url: result.Location,
+                    imgURL: result.Key,
+                    index,
+                });
+            })
+                .catch((err) => reject(err));
         })
-            .catch((err) => reject(err));
+            .catch((err) => {
+            reject(err);
+        });
     });
 }
 exports.default = {
     createS3Client,
-    createUploadTask
+    createUploadTask,
 };

package/dist/utils.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { IImgInfo } from 'picgo/dist/src/types';
+import { IImgInfo } from "picgo/dist/src/types";
 export declare function formatPath(info: IImgInfo, format?: string): string;
 export declare function extractInfo(info: IImgInfo): Promise<{
     body?: Buffer;

package/dist/utils.js

@@ -29,36 +29,34 @@ class FileNameGenerator {
         return this.info.fileName;
     }
     fileName() {
-        return this.info.fileName.replace(this.info.extname, '');
+        return this.info.fileName.replace(this.info.extname, "");
     }
     extName() {
-        return this.info.extname.replace('.', '');
+        return this.info.extname.replace(".", "");
     }
     md5() {
-        return crypto_1.default.createHash('md5').update(this.imgBuffer()).digest('hex');
+        return crypto_1.default.createHash("md5").update(this.imgBuffer()).digest("hex");
     }
     sha1() {
-        return crypto_1.default.createHash('sha1').update(this.imgBuffer()).digest('hex');
+        return crypto_1.default.createHash("sha1").update(this.imgBuffer()).digest("hex");
     }
     sha256() {
-        return crypto_1.default.createHash('sha256').update(this.imgBuffer()).digest('hex');
+        return crypto_1.default.createHash("sha256").update(this.imgBuffer()).digest("hex");
     }
     imgBuffer() {
-        return this.info.base64Image
-            ? this.info.base64Image
-            : this.info.buffer;
+        return this.info.base64Image ? this.info.base64Image : this.info.buffer;
     }
 }
 FileNameGenerator.fields = [
-    'year',
-    'month',
-    'day',
-    'fullName',
-    'fileName',
-    'extName',
-    'md5',
-    'sha1',
-    'sha256'
+    "year",
+    "month",
+    "day",
+    "fullName",
+    "fileName",
+    "extName",
+    "md5",
+    "sha1",
+    "sha256",
 ];
 function formatPath(info, format) {
     if (!format) {
@@ -66,8 +64,8 @@ function formatPath(info, format) {
     }
     const fileNameGenerator = new FileNameGenerator(info);
     let formatPath = format;
-    for (let key of FileNameGenerator.fields) {
-        const re = new RegExp(`{${key}}`, 'g');
+    for (const key of FileNameGenerator.fields) {
+        const re = new RegExp(`{${key}}`, "g");
         formatPath = formatPath.replace(re, fileNameGenerator[key]());
     }
     return formatPath;
@@ -75,12 +73,12 @@ function formatPath(info, format) {
 exports.formatPath = formatPath;
 async function extractInfo(info) {
     var _a;
-    let result = {};
+    const result = {};
     if (info.base64Image) {
-        const body = info.base64Image.replace(/^data:[/\w]+;base64,/, '');
+        const body = info.base64Image.replace(/^data:[/\w]+;base64,/, "");
         result.contentType = (_a = info.base64Image.match(/[^:]\w+\/[\w-+\d.]+(?=;|,)/)) === null || _a === void 0 ? void 0 : _a[0];
-        result.body = Buffer.from(body, 'base64');
-        result.contentEncoding = 'base64';
+        result.body = Buffer.from(body, "base64");
+        result.contentEncoding = "base64";
     }
     else {
         if (info.extname) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picgo-plugin-s3",
-  "version": "1.1.4",
+  "version": "1.2.1",
   "description": "picgo amazon s3 uploader",
   "main": "dist/index.js",
   "publishConfig": {
@@ -27,17 +27,15 @@
   "author": "WayJam So",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^10.10.1",
-    "eslint": "^5.0.1",
-    "eslint-config-standard": "^11.0.0",
-    "eslint-plugin-import": "^2.13.0",
-    "eslint-plugin-node": "^6.0.1",
-    "eslint-plugin-promise": "^3.8.0",
-    "eslint-plugin-standard": "^3.1.0",
+    "@types/node": "^18.7.23",
+    "@typescript-eslint/eslint-plugin": "^5.38.1",
+    "@typescript-eslint/parser": "^5.38.1",
+    "eslint": "^8.25.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
     "picgo": "^1.4.0 >1.4.16",
-    "tslint": "^5.10.0",
-    "tslint-config-standard": "^7.1.0",
-    "typescript": "^3.7.3"
+    "prettier": "^2.7.1",
+    "typescript": "^4.8.4"
   },
   "dependencies": {
     "aws-sdk": "^2.839.0",