@kevisual/oss 0.0.1 → 0.0.2

package/dist/{index-BNtwSChY.d.ts → index-CQoepWCw.d.ts}

@@ -123,6 +123,9 @@ declare class OssBase implements OssBaseOperation {
     fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<any>;
     statObject(objectName: string): Promise<minio.BucketItemStat>;
     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 +133,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 OssBaseOptions as a, type OssService as b, type ListObjectResult as c };

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-CQoepWCw.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;
@@ -116,6 +134,10 @@ var OssBase = class {
     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, b as OssService, a as OssBaseOptions, L as ListFileObject, c as ListObjectResult } from '../index-CQoepWCw.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;
@@ -119,6 +137,10 @@ var OssBase = class {
     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-CQoepWCw.js';
+export { a as OssBaseOptions } from '../index-CQoepWCw.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;
@@ -119,6 +137,10 @@ var OssBase = class {
     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 +215,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.2",
   "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"