picgo-plugin-s3 1.1.0 → 1.1.4

package/README.md

@@ -29,6 +29,8 @@ picgo set uploader aws-s3
 | `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` |
 
 **上传路径支持 payload：**
 
@@ -59,6 +61,16 @@ picgo set uploader aws-s3
 
 如果 PicGo 像以上配置，执行上传：`picgo upload sample.png`，则最终得到图片地址为：`https://img.example.com/2021/4aa4f41e38817e5fd38ac870f40dbc70.jpg`
 
+## 发布 Publish
+
+With the following command, a versioned commit which modifies the `version` of `package.json` would be genereated and pushed to the origin. Github Action will automatically compile this pacakage and publish it to NPM.
+
+```sh
+npm run patch
+npm run minor
+npm run major
+```
+
 ## 贡献 Contributing
 
 Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

package/dist/index.js

@@ -11,7 +11,9 @@ module.exports = (ctx) => {
             secretAccessKey: '',
             bucketName: '',
             uploadPath: '{year}/{month}/{md5}.{extName}',
-            pathStyleAccess: false
+            pathStyleAccess: false,
+            rejectUnauthorized: true,
+            acl: 'public-read'
         };
         let userConfig = ctx.getConfig('picBed.aws-s3');
         userConfig = Object.assign(Object.assign({}, defaultConfig), (userConfig || {}));
@@ -46,6 +48,14 @@ module.exports = (ctx) => {
                 required: true,
                 alias: '文件路径'
             },
+            {
+                name: 'acl',
+                type: 'input',
+                default: userConfig.acl,
+                message: '文件访问权限',
+                required: true,
+                alias: '权限'
+            },
             {
                 name: 'region',
                 type: 'input',
@@ -75,6 +85,22 @@ module.exports = (ctx) => {
                 message: 'enable path-style-access or not',
                 required: false,
                 alias: 'PathStyleAccess'
+            },
+            {
+                name: 'rejectUnauthorized',
+                type: 'confirm',
+                default: userConfig.rejectUnauthorized || true,
+                message: '是否拒绝无效TLS证书连接',
+                required: false,
+                alias: 'rejectUnauthorized'
+            },
+            {
+                name: 'acl',
+                type: 'input',
+                default: userConfig.acl || 'public-read',
+                message: '上传资源的访问策略',
+                required: false,
+                alias: 'ACL 访问控制列表'
             }
         ];
     };
@@ -86,9 +112,9 @@ module.exports = (ctx) => {
         if (userConfig.urlPrefix) {
             userConfig.urlPrefix = userConfig.urlPrefix.replace(/\/?$/, '');
         }
-        const client = uploader_1.default.createS3Client(userConfig.accessKeyID, userConfig.secretAccessKey, userConfig.region, userConfig.endpoint, userConfig.pathStyleAccess);
+        const client = uploader_1.default.createS3Client(userConfig.accessKeyID, userConfig.secretAccessKey, userConfig.region, userConfig.endpoint, userConfig.pathStyleAccess, userConfig.rejectUnauthorized);
         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));
+        const tasks = output.map((item, idx) => uploader_1.default.createUploadTask(client, userConfig.bucketName, utils_1.formatPath(item, userConfig.uploadPath), item, idx, userConfig.acl));
         try {
             const results = await Promise.all(tasks);
             for (let result of results) {

package/dist/uploader.d.ts

@@ -5,8 +5,8 @@ export interface IUploadResult {
     imgURL: string;
     index: number;
 }
-declare function createS3Client(accessKeyID: string, secretAccessKey: string, region: string, endpoint: string, pathStyleAccess: boolean): AWS.S3;
-declare function createUploadTask(s3: AWS.S3, bucketName: string, path: string, item: IImgInfo, index: number): Promise<IUploadResult>;
+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 const _default: {
     createS3Client: typeof createS3Client;
     createUploadTask: typeof createUploadTask;

package/dist/uploader.js

@@ -4,41 +4,37 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
-const file_type_1 = __importDefault(require("file-type"));
-function createS3Client(accessKeyID, secretAccessKey, region, endpoint, pathStyleAccess) {
+const https_1 = __importDefault(require("https"));
+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
+        s3ForcePathStyle: pathStyleAccess,
+        httpOptions: {
+            agent: new https_1.default.Agent({
+                rejectUnauthorized: rejectUnauthorized,
+            })
+        }
     });
     return s3;
 }
-function createUploadTask(s3, bucketName, path, item, index) {
+function createUploadTask(s3, bucketName, path, item, index, acl) {
     return new Promise(async (resolve, reject) => {
         if (!item.buffer && !item.base64Image) {
             reject(new Error('undefined image'));
         }
+        const { body, contentType, contentEncoding } = await utils_1.extractInfo(item);
         const opts = {
             Key: path,
-            Bucket: bucketName
+            Bucket: bucketName,
+            ACL: acl,
+            Body: body,
+            ContentType: contentType,
+            ContentEncoding: contentEncoding,
         };
-        if (item.buffer) {
-            opts.Body = item.buffer;
-            // 不知道是否会发生未获取到 mime 类型就上传文件的情况
-            const fileType = await file_type_1.default.fromBuffer(item.buffer);
-            opts.ContentType = fileType.mime;
-        }
-        else {
-            let data = item.base64Image;
-            const format = data.substring(data.indexOf('data:') + 5, data.indexOf(';base64'));
-            data = data.replace(/^data:image\/\w+;base64,/, '');
-            const buf = Buffer.from(data, 'base64');
-            opts.Body = buf;
-            opts.ContentEncoding = 'base64';
-            opts.ContentType = format;
-        }
         s3.upload(opts)
             .promise()
             .then((result) => {

package/dist/utils.d.ts

@@ -1,2 +1,8 @@
+/// <reference types="node" />
 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;
+    contentType?: string;
+    contentEncoding?: string;
+}>;

package/dist/utils.js

@@ -3,8 +3,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPath = void 0;
+exports.extractInfo = exports.formatPath = void 0;
 const crypto_1 = __importDefault(require("crypto"));
+const file_type_1 = __importDefault(require("file-type"));
+const mime_1 = __importDefault(require("mime"));
 class FileNameGenerator {
     constructor(info) {
         this.date = new Date();
@@ -44,7 +46,7 @@ class FileNameGenerator {
     imgBuffer() {
         return this.info.base64Image
             ? this.info.base64Image
-            : this.info.buffer.toString();
+            : this.info.buffer;
     }
 }
 FileNameGenerator.fields = [
@@ -71,3 +73,26 @@ function formatPath(info, format) {
     return formatPath;
 }
 exports.formatPath = formatPath;
+async function extractInfo(info) {
+    var _a;
+    let result = {};
+    if (info.base64Image) {
+        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';
+    }
+    else {
+        if (info.extname) {
+            result.contentType = mime_1.default.getType(info.extname);
+        }
+        result.body = info.buffer;
+    }
+    // fallback to detect from buffer
+    if (!result.contentType) {
+        const fileType = await file_type_1.default.fromBuffer(result.body);
+        result.contentType = fileType === null || fileType === void 0 ? void 0 : fileType.mime;
+    }
+    return result;
+}
+exports.extractInfo = extractInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "picgo-plugin-s3",
-  "version": "1.1.0",
+  "version": "1.1.4",
   "description": "picgo amazon s3 uploader",
   "main": "dist/index.js",
   "publishConfig": {
@@ -12,9 +12,9 @@
     "build": "tsc -p .",
     "dev": "tsc -w -p .",
     "pub": "rm -rf dist/* && npm build && npm publish",
-    "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 -m 'bump version into v%s' && git push origin main && git push origin --tags",
+    "minor": "npm version minor -m 'bump version into v%s' && git push origin main && git push origin --tags",
+    "major": "npm version major -m 'bump version into v%s' && git push origin main && git push origin --tags"
   },
   "keywords": [
     "amazon-s3",
@@ -41,6 +41,7 @@
   },
   "dependencies": {
     "aws-sdk": "^2.839.0",
-    "file-type": "^16.2.0"
+    "file-type": "^16.2.0",
+    "mime": "^2.5.2"
   }
 }