@kevisual/oss 0.0.1 → 0.0.4

package/dist/{index-BNtwSChY.d.ts → index-z-16S9o1.d.ts}

@@ -121,8 +121,18 @@ declare class OssBase implements OssBaseOperation {
         startAfter?: string;
     }): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
     fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<any>;
-    statObject(objectName: string): Promise<minio.BucketItemStat>;
+    statObject(objectName: string, checkFile?: boolean): Promise<minio.BucketItemStat>;
+    /**
+     * 检查文件hash是否一致
+     * @param objectName
+     * @param hash
+     * @returns
+     */
+    checkFileHash(objectName: string, hash: string): Promise<boolean>;
     copyObject(sourceObject: any, targetObject: any): Promise<minio_dist_esm_internal_type_mjs.CopyObjectResult>;
+    replaceObject(objectName: string, meta: {
+        [key: string]: string;
+    }): Promise<minio_dist_esm_internal_type_mjs.CopyObjectResult>;
     static create<T extends OssBase, U>(this: new (opts: OssBaseOptions<U>) => T, opts: OssBaseOptions<U>): T;
     static fromBase<T extends OssBase, U>(this: new (opts: OssBaseOptions<U>) => T, createOpts: {
         oss: OssBase;
@@ -130,4 +140,4 @@ declare class OssBase implements OssBaseOperation {
     }): T;
 }
 
-export { type ListFileObject as L, OssBase as O, type OssService as a, type OssBaseOptions as b, type ListObjectResult as c };
+export { type ListFileObject as L, OssBase as O, type StatObjectResult as S, type UploadedObjectInfo as U, type OssBaseOptions as a, type ListDirectoryObject as b, type ListObjectResult as c, type OssBaseOperation as d, type OssService as e };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 import 'minio';
 import 'minio/dist/esm/internal/type.mjs';
 import 'stream';
-export { O as OssBase, b as OssBaseOptions } from './index-BNtwSChY.js';
+export { O as OssBase, a as OssBaseOptions } from './index-z-16S9o1.js';

package/dist/index.js

@@ -1,5 +1,5 @@
 // src/util/hash.ts
-import crypto from "crypto";
+import crypto from "node:crypto";
 var hash = (str) => {
   let hashStr;
   if (typeof str === "object") {
@@ -10,6 +10,22 @@ var hash = (str) => {
   return crypto.createHash("md5").update(hashStr).digest("hex");
 };
 
+// src/core/copy-object.ts
+import { CopyDestinationOptions, CopySourceOptions } from "minio";
+var copyObject = async ({ bucketName, newMetadata, objectName, client }) => {
+  const source = new CopySourceOptions({ Bucket: bucketName, Object: objectName });
+  const stat = await client.statObject(bucketName, objectName);
+  const sourceMetadata = stat.metaData;
+  const destination = new CopyDestinationOptions({
+    Bucket: bucketName,
+    Object: objectName,
+    UserMetadata: { ...sourceMetadata, ...newMetadata },
+    MetadataDirective: "REPLACE"
+  });
+  const copyResult = await client.copyObject(source, destination);
+  return copyResult;
+};
+
 // src/index.ts
 var OssBase = class {
   client;
@@ -25,7 +41,7 @@ var OssBase = class {
     }
     this.bucketName = opts.bucketName;
     this.client = opts.client;
-    this.prefix = opts.prefix;
+    this.prefix = opts?.prefix ?? "";
   }
   setPrefix(prefix) {
     this.prefix = prefix;
@@ -57,12 +73,14 @@ var OssBase = class {
   }
   async putObject(objectName, data, metaData) {
     let putData;
+    let size;
     if (typeof data === "object") {
       putData = JSON.stringify(data);
-    } else {
+      size = putData.length;
+    } else if (typeof data === "string") {
       putData = data;
+      size = putData.length;
     }
-    const size = putData.length;
     const bucketName = this.bucketName;
     const obj = await this.client.putObject(bucketName, `${this.prefix}${objectName}`, putData, size, metaData);
     return obj;
@@ -99,10 +117,13 @@ var OssBase = class {
     const obj = await this.client.fPutObject(bucketName, `${this.prefix}${objectName}`, filePath, metaData);
     return obj;
   }
-  async statObject(objectName) {
+  async statObject(objectName, checkFile = true) {
     const bucketName = this.bucketName;
     try {
       const obj = await this.client.statObject(bucketName, `${this.prefix}${objectName}`);
+      if (obj && checkFile && obj.size === 0) {
+        return null;
+      }
       return obj;
     } catch (e) {
       if (e.code === "NotFound") {
@@ -111,11 +132,28 @@ var OssBase = class {
       throw e;
     }
   }
+  /**
+   * 检查文件hash是否一致
+   * @param objectName
+   * @param hash
+   * @returns
+   */
+  async checkFileHash(objectName, hash2) {
+    const obj = await this.statObject(`${this.prefix}${objectName}`, true);
+    if (!obj) {
+      return false;
+    }
+    return obj.etag === hash2;
+  }
   async copyObject(sourceObject, targetObject) {
     const bucketName = this.bucketName;
     const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
     return obj;
   }
+  async replaceObject(objectName, meta) {
+    const { bucketName, client } = this;
+    return copyObject({ bucketName, client, objectName: `${this.prefix}${objectName}`, newMetadata: meta });
+  }
   static create(opts) {
     return new this(opts);
   }

package/dist/services/config.d.ts

@@ -1,5 +1,5 @@
-import { O as OssBase, a as OssService, b as OssBaseOptions, L as ListFileObject, c as ListObjectResult } from '../index-BNtwSChY.js';
 import * as minio_dist_esm_internal_type_mjs from 'minio/dist/esm/internal/type.mjs';
+import { O as OssBase, e as OssService, a as OssBaseOptions, L as ListFileObject, c as ListObjectResult } from '../index-z-16S9o1.js';
 import 'minio';
 import 'stream';
 

package/dist/services/config.js

@@ -1,5 +1,5 @@
 // src/util/hash.ts
-import crypto from "crypto";
+import crypto from "node:crypto";
 var hash = (str) => {
   let hashStr;
   if (typeof str === "object") {
@@ -13,6 +13,22 @@ var hashSringify = (str) => {
   return JSON.stringify(str, null, 2);
 };
 
+// src/core/copy-object.ts
+import { CopyDestinationOptions, CopySourceOptions } from "minio";
+var copyObject = async ({ bucketName, newMetadata, objectName, client }) => {
+  const source = new CopySourceOptions({ Bucket: bucketName, Object: objectName });
+  const stat = await client.statObject(bucketName, objectName);
+  const sourceMetadata = stat.metaData;
+  const destination = new CopyDestinationOptions({
+    Bucket: bucketName,
+    Object: objectName,
+    UserMetadata: { ...sourceMetadata, ...newMetadata },
+    MetadataDirective: "REPLACE"
+  });
+  const copyResult = await client.copyObject(source, destination);
+  return copyResult;
+};
+
 // src/index.ts
 var OssBase = class {
   client;
@@ -28,7 +44,7 @@ var OssBase = class {
     }
     this.bucketName = opts.bucketName;
     this.client = opts.client;
-    this.prefix = opts.prefix;
+    this.prefix = opts?.prefix ?? "";
   }
   setPrefix(prefix) {
     this.prefix = prefix;
@@ -60,12 +76,14 @@ var OssBase = class {
   }
   async putObject(objectName, data, metaData) {
     let putData;
+    let size;
     if (typeof data === "object") {
       putData = JSON.stringify(data);
-    } else {
+      size = putData.length;
+    } else if (typeof data === "string") {
       putData = data;
+      size = putData.length;
     }
-    const size = putData.length;
     const bucketName = this.bucketName;
     const obj = await this.client.putObject(bucketName, `${this.prefix}${objectName}`, putData, size, metaData);
     return obj;
@@ -102,10 +120,13 @@ var OssBase = class {
     const obj = await this.client.fPutObject(bucketName, `${this.prefix}${objectName}`, filePath, metaData);
     return obj;
   }
-  async statObject(objectName) {
+  async statObject(objectName, checkFile = true) {
     const bucketName = this.bucketName;
     try {
       const obj = await this.client.statObject(bucketName, `${this.prefix}${objectName}`);
+      if (obj && checkFile && obj.size === 0) {
+        return null;
+      }
       return obj;
     } catch (e) {
       if (e.code === "NotFound") {
@@ -114,11 +135,28 @@ var OssBase = class {
       throw e;
     }
   }
+  /**
+   * 检查文件hash是否一致
+   * @param objectName
+   * @param hash
+   * @returns
+   */
+  async checkFileHash(objectName, hash2) {
+    const obj = await this.statObject(`${this.prefix}${objectName}`, true);
+    if (!obj) {
+      return false;
+    }
+    return obj.etag === hash2;
+  }
   async copyObject(sourceObject, targetObject) {
     const bucketName = this.bucketName;
     const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
     return obj;
   }
+  async replaceObject(objectName, meta) {
+    const { bucketName, client } = this;
+    return copyObject({ bucketName, client, objectName: `${this.prefix}${objectName}`, newMetadata: meta });
+  }
   static create(opts) {
     return new this(opts);
   }

package/dist/services/index.d.ts

@@ -1,5 +1,36 @@
-export { O as OssBase, b as OssBaseOptions } from '../index-BNtwSChY.js';
+import { O as OssBase } from '../index-z-16S9o1.js';
+export { b as ListDirectoryObject, L as ListFileObject, c as ListObjectResult, d as OssBaseOperation, a as OssBaseOptions, e as OssService, S as StatObjectResult, U as UploadedObjectInfo } from '../index-z-16S9o1.js';
 export { ConfigOssService } from './config.js';
+import * as stream from 'stream';
+import { ServerResponse } from 'node:http';
 import 'minio';
 import 'minio/dist/esm/internal/type.mjs';
-import 'stream';
+
+/**
+ * 过滤 metaData 中的 key, 去除 password, accesskey, secretkey，
+ * 并返回过滤后的 metaData
+ * @param metaData
+ * @returns
+ */
+declare const filterMetaDataKeys: (metaData: Record<string, string>, clearKeys?: string[]) => Record<string, string>;
+type SendObjectOptions = {
+    res: ServerResponse;
+    client: OssBase;
+    objectName: string;
+    isDownload?: boolean;
+};
+declare const NotFoundFile: (res: ServerResponse, msg?: string, code?: number) => void;
+declare const sendObject: ({ res, objectName, client, isDownload }: SendObjectOptions) => Promise<void>;
+declare const downloadObject: ({ objectName, client, filePath }: Pick<SendObjectOptions, "objectName" | "client"> & {
+    filePath: string;
+}) => Promise<stream.Readable>;
+
+/**
+ * 计算字符串的md5值
+ * @param str
+ * @returns
+ */
+declare const hash: (str: string | Buffer | Object) => string;
+declare const hashSringify: (str: Object) => string;
+
+export { NotFoundFile, OssBase, downloadObject, filterMetaDataKeys, hash, hashSringify, sendObject };

package/dist/services/index.js

@@ -1,5 +1,5 @@
 // src/util/hash.ts
-import crypto from "crypto";
+import crypto from "node:crypto";
 var hash = (str) => {
   let hashStr;
   if (typeof str === "object") {
@@ -13,6 +13,22 @@ var hashSringify = (str) => {
   return JSON.stringify(str, null, 2);
 };
 
+// src/core/copy-object.ts
+import { CopyDestinationOptions, CopySourceOptions } from "minio";
+var copyObject = async ({ bucketName, newMetadata, objectName, client }) => {
+  const source = new CopySourceOptions({ Bucket: bucketName, Object: objectName });
+  const stat = await client.statObject(bucketName, objectName);
+  const sourceMetadata = stat.metaData;
+  const destination = new CopyDestinationOptions({
+    Bucket: bucketName,
+    Object: objectName,
+    UserMetadata: { ...sourceMetadata, ...newMetadata },
+    MetadataDirective: "REPLACE"
+  });
+  const copyResult = await client.copyObject(source, destination);
+  return copyResult;
+};
+
 // src/index.ts
 var OssBase = class {
   client;
@@ -28,7 +44,7 @@ var OssBase = class {
     }
     this.bucketName = opts.bucketName;
     this.client = opts.client;
-    this.prefix = opts.prefix;
+    this.prefix = opts?.prefix ?? "";
   }
   setPrefix(prefix) {
     this.prefix = prefix;
@@ -60,12 +76,14 @@ var OssBase = class {
   }
   async putObject(objectName, data, metaData) {
     let putData;
+    let size;
     if (typeof data === "object") {
       putData = JSON.stringify(data);
-    } else {
+      size = putData.length;
+    } else if (typeof data === "string") {
       putData = data;
+      size = putData.length;
     }
-    const size = putData.length;
     const bucketName = this.bucketName;
     const obj = await this.client.putObject(bucketName, `${this.prefix}${objectName}`, putData, size, metaData);
     return obj;
@@ -102,10 +120,13 @@ var OssBase = class {
     const obj = await this.client.fPutObject(bucketName, `${this.prefix}${objectName}`, filePath, metaData);
     return obj;
   }
-  async statObject(objectName) {
+  async statObject(objectName, checkFile = true) {
     const bucketName = this.bucketName;
     try {
       const obj = await this.client.statObject(bucketName, `${this.prefix}${objectName}`);
+      if (obj && checkFile && obj.size === 0) {
+        return null;
+      }
       return obj;
     } catch (e) {
       if (e.code === "NotFound") {
@@ -114,11 +135,28 @@ var OssBase = class {
       throw e;
     }
   }
+  /**
+   * 检查文件hash是否一致
+   * @param objectName
+   * @param hash
+   * @returns
+   */
+  async checkFileHash(objectName, hash2) {
+    const obj = await this.statObject(`${this.prefix}${objectName}`, true);
+    if (!obj) {
+      return false;
+    }
+    return obj.etag === hash2;
+  }
   async copyObject(sourceObject, targetObject) {
     const bucketName = this.bucketName;
     const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
     return obj;
   }
+  async replaceObject(objectName, meta) {
+    const { bucketName, client } = this;
+    return copyObject({ bucketName, client, objectName: `${this.prefix}${objectName}`, newMetadata: meta });
+  }
   static create(opts) {
     return new this(opts);
   }
@@ -193,7 +231,69 @@ var ConfigOssService = class extends OssBase {
     return { list: listKeys, keys, keyEtagMap };
   }
 };
+
+// src/util/download.ts
+import fs from "node:fs";
+import path from "node:path";
+var viewableExtensions = ["jpg", "jpeg", "png", "gif", "svg", "webp", "mp4", "webm", "mp3", "wav", "ogg", "pdf", "doc", "docx", "xls", "xlsx", "ppt", "pptx"];
+var filterMetaDataKeys = (metaData, clearKeys = []) => {
+  const keys = Object.keys(metaData);
+  const removeKeys = ["password", "accesskey", "secretkey", ...clearKeys];
+  const filteredKeys = keys.filter((key) => !removeKeys.includes(key));
+  return filteredKeys.reduce((acc, key) => {
+    acc[key] = metaData[key];
+    return acc;
+  }, {});
+};
+var NotFoundFile = (res, msg, code = 404) => {
+  res.writeHead(code, { "Content-Type": "text/plain" });
+  res.end(msg || "Not Found File");
+  return;
+};
+var sendObject = async ({ res, objectName, client, isDownload = false }) => {
+  let stat;
+  try {
+    stat = await client.statObject(objectName);
+  } catch (e) {
+  } finally {
+    if (!stat || stat.size === 0) {
+      return NotFoundFile(res);
+    }
+    const contentLength = stat.size;
+    const etag = stat.etag;
+    const lastModified = stat.lastModified.toISOString();
+    const filename = objectName.split("/").pop() || "no-file-name-download";
+    const fileExtension = filename.split(".").pop()?.toLowerCase() || "";
+    const filteredMetaData = filterMetaDataKeys(stat.metaData, ["size", "etag", "last-modified"]);
+    const contentDisposition = viewableExtensions.includes(fileExtension) && !isDownload ? "inline" : `attachment; filename="${filename}"`;
+    res.writeHead(200, {
+      "Content-Length": contentLength,
+      etag,
+      "last-modified": lastModified,
+      "Content-Disposition": contentDisposition,
+      "file-name": filename,
+      ...filteredMetaData
+    });
+    const objectStream = await client.getObject(objectName);
+    objectStream.pipe(res, { end: true });
+  }
+};
+var downloadObject = async ({ objectName, client, filePath }) => {
+  const objectStream = await client.getObject(objectName);
+  const dir = path.dirname(filePath);
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+  objectStream.pipe(fs.createWriteStream(filePath));
+  return objectStream;
+};
 export {
   ConfigOssService,
-  OssBase
+  NotFoundFile,
+  OssBase,
+  downloadObject,
+  filterMetaDataKeys,
+  hash,
+  hashSringify,
+  sendObject
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kevisual/oss",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -16,13 +16,23 @@
   "license": "MIT",
   "type": "module",
   "devDependencies": {
-    "dotenv": "^16.4.7",
+    "dotenv": "^16.5.0",
     "minio": "^8.0.5",
     "tsup": "^8.4.0"
   },
   "exports": {
-    "./*": "./dist/*.js",
-    "./services": "./dist/services/index.js"
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./config": {
+      "import": "./dist/services/config.js",
+      "types": "./dist/services/config.d.ts"
+    },
+    "./services": {
+      "import": "./dist/services/index.js",
+      "types": "./dist/services/index.d.ts"
+    }
   },
   "publishConfig": {
     "access": "public"