@kevisual/oss 0.0.17 → 0.0.19

package/dist/index.d.ts

@@ -15,12 +15,20 @@ type StatObjectResult = {
     lastModified: Date;
     metaData: ItemBucketMetadata;
     versionId?: string | null;
+    standardHeaders: {
+        contentType?: string;
+        cacheControl?: string;
+        contentDisposition?: string;
+        contentEncoding?: string;
+        contentLanguage?: string;
+    };
 };
 type ListFileObject = {
     name: string;
     size: number;
     lastModified: Date;
     etag: string;
+    metaData?: ItemBucketMetadata;
 };
 type ListDirectoryObject = {
     prefix: string;
@@ -129,6 +137,9 @@ interface OssBaseOperation {
      */
     replaceObject?(objectName: string, meta: ItemBucketMetadata): Promise<any>;
 }
+interface OssService extends OssBaseOperation {
+    owner: string;
+}
 
 type OssBaseOptions<T = {
     [key: string]: any;
@@ -206,6 +217,7 @@ declare class OssBase implements OssBaseOperation {
         recursive?: boolean;
         startAfter?: string;
         maxKeys?: number;
+        getMeta?: boolean;
     }): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
     /**
      * 获取对象信息
@@ -260,6 +272,7 @@ declare class OssBase implements OssBaseOperation {
         opts: Partial<OssBaseOptions<U>>;
     }): T;
 }
+declare const getStram: (data: GetObjectCommandOutput) => Readable;
 
-export { OssBase };
-export type { OssBaseOptions };
+export { OssBase, getStram };
+export type { ItemBucketMetadata, ListDirectoryObject, ListFileObject, ListObjectResult, OssBaseOperation, OssBaseOptions, OssService, StatObjectResult, UploadedObjectInfo };

package/dist/index.js

@@ -36452,15 +36452,21 @@ class OssBase {
         contentLength = Buffer.byteLength(putData);
       }
     } else {
-      putData = data;
       if (!contentLength) {
-        throw new Error("Stream upload requires size parameter");
+        const chunks = [];
+        for await (const chunk of data) {
+          chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
+        }
+        putData = Buffer.concat(chunks);
+        contentLength = putData.length;
+      } else {
+        putData = data;
       }
     }
     if (opts?.check) {
       const obj = await this.statObject(objectName, true);
       if (obj) {
-        const omitMeta = ["size", "Content-Type", "Cache-Control", "app-source"];
+        const omitMeta = ["size", "content-type", "cache-control", "app-source"];
         const objMeta = JSON.parse(JSON.stringify(omit(obj.metaData, omitMeta)));
         metaData = {
           ...objMeta,
@@ -36489,22 +36495,41 @@ class OssBase {
     };
   }
   async fPutObject(objectName, filePath, metaData) {
-    const fileStream = fs.createReadStream(filePath);
     const stat = fs.statSync(filePath);
     const { standardHeaders, customMetadata } = extractStandardHeaders(metaData || {});
-    const command = new import_client_s3.PutObjectCommand({
-      Bucket: this.bucketName,
-      Key: `${this.prefix}${objectName}`,
-      Body: fileStream,
-      ContentLength: stat.size,
-      ContentType: standardHeaders.ContentType || getContentType(filePath),
-      CacheControl: standardHeaders.CacheControl,
-      ContentDisposition: standardHeaders.ContentDisposition,
-      ContentEncoding: standardHeaders.ContentEncoding,
-      ContentLanguage: standardHeaders.ContentLanguage,
-      Expires: standardHeaders.Expires,
-      Metadata: customMetadata
-    });
+    const THRESHOLD = 5 * 1024 * 1024;
+    let command;
+    if (stat.size < THRESHOLD) {
+      const fileBuffer = await fs.promises.readFile(filePath);
+      command = new import_client_s3.PutObjectCommand({
+        Bucket: this.bucketName,
+        Key: `${this.prefix}${objectName}`,
+        Body: fileBuffer,
+        ContentLength: fileBuffer.length,
+        ContentType: standardHeaders.ContentType || getContentType(filePath),
+        CacheControl: standardHeaders.CacheControl,
+        ContentDisposition: standardHeaders.ContentDisposition,
+        ContentEncoding: standardHeaders.ContentEncoding,
+        ContentLanguage: standardHeaders.ContentLanguage,
+        Expires: standardHeaders.Expires,
+        Metadata: customMetadata
+      });
+    } else {
+      const fileStream = fs.createReadStream(filePath);
+      command = new import_client_s3.PutObjectCommand({
+        Bucket: this.bucketName,
+        Key: `${this.prefix}${objectName}`,
+        Body: fileStream,
+        ContentLength: stat.size,
+        ContentType: standardHeaders.ContentType || getContentType(filePath),
+        CacheControl: standardHeaders.CacheControl,
+        ContentDisposition: standardHeaders.ContentDisposition,
+        ContentEncoding: standardHeaders.ContentEncoding,
+        ContentLanguage: standardHeaders.ContentLanguage,
+        Expires: standardHeaders.Expires,
+        Metadata: customMetadata
+      });
+    }
     const response = await this.client.send(command);
     return {
       etag: response.ETag?.replace(/"/g, "") || "",
@@ -36527,6 +36552,7 @@ class OssBase {
     const prefix = `${this.prefix}${objectName}`;
     const results = [];
     let continuationToken;
+    const getMeta = opts?.getMeta ?? false;
     do {
       const command = new import_client_s3.ListObjectsV2Command({
         Bucket: this.bucketName,
@@ -36539,12 +36565,19 @@ class OssBase {
       const response = await this.client.send(command);
       if (response.Contents) {
         for (const item of response.Contents) {
-          results.push({
+          const result = {
             name: item.Key || "",
             size: item.Size || 0,
             lastModified: item.LastModified || new Date,
             etag: item.ETag?.replace(/"/g, "") || ""
-          });
+          };
+          if (getMeta) {
+            const stat = await this.statObject(item.Key || "", false);
+            if (stat?.metaData) {
+              result.metaData = stat.metaData;
+            }
+          }
+          results.push(result);
         }
       }
       if (response.CommonPrefixes && !opts?.recursive) {
@@ -36567,6 +36600,13 @@ class OssBase {
       });
       const response = await this.client.send(command);
       return {
+        standardHeaders: {
+          contentType: response.ContentType,
+          cacheControl: response.CacheControl,
+          contentDisposition: response.ContentDisposition,
+          contentEncoding: response.ContentEncoding,
+          contentLanguage: response.ContentLanguage
+        },
         size: response.ContentLength || 0,
         etag: response.ETag?.replace?.(/"/g, "") || "",
         lastModified: response.LastModified || new Date,
@@ -36574,11 +36614,11 @@ class OssBase {
         versionId: response.VersionId || null
       };
     } catch (e) {
-      console.error("statObject error", e);
       const isNotFound = e.name === "NotFound" || e.name === "NoSuchBucket" || e.name === "NoSuchKey" || e.code === "NotFound" || e.code === "NoSuchBucket" || e.code === "NoSuchKey" || e.$metadata?.httpStatusCode === 404;
       if (checkFile && isNotFound) {
         return null;
       }
+      console.error("statObject error", e);
       throw e;
     }
   }
@@ -36659,6 +36699,13 @@ class OssBase {
     });
   }
 }
+var getStram = (data) => {
+  if (data.Body) {
+    return data.Body;
+  }
+  throw new Error("Object body is empty");
+};
 export {
+  getStram,
   OssBase
 };

package/dist/services.d.ts

@@ -1,36 +1,41 @@
-import * as _aws_sdk_client_s3 from '@aws-sdk/client-s3';
 import { CopyObjectCommandOutput, S3Client, GetObjectCommandOutput } from '@aws-sdk/client-s3';
 import { Readable } from 'node:stream';
-import { ServerResponse } from 'node:http';
-import { ItemBucketMetadata as ItemBucketMetadata$1, Client } from 'minio';
 
 type ItemBucketMetadata = Record<string, string>;
-type UploadedObjectInfo$1 = {
+type UploadedObjectInfo = {
     etag: string;
     lastModified?: Date;
     size?: number;
     versionId: string;
     metadata?: ItemBucketMetadata;
 };
-type StatObjectResult$1 = {
+type StatObjectResult = {
     size: number;
     etag: string;
     lastModified: Date;
     metaData: ItemBucketMetadata;
     versionId?: string | null;
+    standardHeaders: {
+        contentType?: string;
+        cacheControl?: string;
+        contentDisposition?: string;
+        contentEncoding?: string;
+        contentLanguage?: string;
+    };
 };
-type ListFileObject$1 = {
+type ListFileObject = {
     name: string;
     size: number;
     lastModified: Date;
     etag: string;
+    metaData?: ItemBucketMetadata;
 };
-type ListDirectoryObject$1 = {
+type ListDirectoryObject = {
     prefix: string;
     size: number;
 };
-type ListObjectResult$1 = ListFileObject$1 | ListDirectoryObject$1;
-interface OssBaseOperation$1 {
+type ListObjectResult = ListFileObject | ListDirectoryObject;
+interface OssBaseOperation {
     prefix: string;
     /**
      * 设置前缀
@@ -64,20 +69,20 @@ interface OssBaseOperation$1 {
         isStream?: boolean;
         size?: number;
         contentType?: string;
-    }): Promise<UploadedObjectInfo$1>;
+    }): Promise<UploadedObjectInfo>;
     /**
      * 上传文件
      * @param objectName 对象名
      * @param filePath 文件路径
      * @param metaData 元数据
      */
-    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo$1>;
+    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
     /**
      * 获取对象信息
      * @param objectName 对象名
      * @param checkFile 是否检查文件存在（不存在返回null而非抛错）
      */
-    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult$1 | null>;
+    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult | null>;
     /**
      * 删除对象
      * @param objectName 对象名
@@ -95,7 +100,7 @@ interface OssBaseOperation$1 {
         startAfter?: string;
         /** 最大返回数量 */
         maxKeys?: number;
-    }): Promise<ListObjectResult$1[]>;
+    }): Promise<ListObjectResult[]>;
     /**
      * 获取完整的对象名称
      * @param objectName 对象名
@@ -110,7 +115,7 @@ interface OssBaseOperation$1 {
     checkObjectHash?(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
         success: boolean;
         metaData: ItemBucketMetadata | null;
-        obj: StatObjectResult$1 | null;
+        obj: StatObjectResult | null;
         equalMeta?: boolean;
     }>;
     /**
@@ -132,7 +137,7 @@ interface OssBaseOperation$1 {
      */
     replaceObject?(objectName: string, meta: ItemBucketMetadata): Promise<any>;
 }
-interface OssService$1 extends OssBaseOperation$1 {
+interface OssService extends OssBaseOperation {
     owner: string;
 }
 
@@ -152,7 +157,7 @@ type OssBaseOptions<T = {
      */
     prefix?: string;
 } & T;
-declare class OssBase implements OssBaseOperation$1 {
+declare class OssBase implements OssBaseOperation {
     client: S3Client;
     bucketName: string;
     prefix: string;
@@ -189,14 +194,14 @@ declare class OssBase implements OssBaseOperation$1 {
         isStream?: boolean;
         size?: number;
         contentType?: string;
-    }): Promise<UploadedObjectInfo$1>;
+    }): Promise<UploadedObjectInfo>;
     /**
      * 上传文件
      * @param objectName 对象名
      * @param filePath 文件路径
      * @param metaData 元数据
      */
-    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo$1>;
+    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
     /**
      * 删除对象
      * @param objectName 对象名
@@ -212,13 +217,14 @@ declare class OssBase implements OssBaseOperation$1 {
         recursive?: boolean;
         startAfter?: string;
         maxKeys?: number;
-    }): Promise<IS_FILE extends true ? ListFileObject$1[] : ListObjectResult$1[]>;
+        getMeta?: boolean;
+    }): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
     /**
      * 获取对象信息
      * @param objectName 对象名
      * @param checkFile 是否检查文件存在（不存在返回null而非抛错）
      */
-    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult$1 | null>;
+    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult | null>;
     /**
      * 获取完整的对象名称
      * @param objectName 对象名
@@ -233,7 +239,7 @@ declare class OssBase implements OssBaseOperation$1 {
     checkObjectHash(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
         success: boolean;
         metaData: ItemBucketMetadata | null;
-        obj: StatObjectResult$1 | null;
+        obj: StatObjectResult | null;
         equalMeta?: boolean;
     }>;
     /**
@@ -267,18 +273,18 @@ declare class OssBase implements OssBaseOperation$1 {
     }): T;
 }
 
-declare class ConfigOssService extends OssBase implements OssService$1 {
+declare class ConfigOssService extends OssBase implements OssService {
     owner: string;
     constructor(opts: OssBaseOptions<{
         owner: string;
     }>);
-    listAllFile(): Promise<ListFileObject$1[]>;
-    listAll(): Promise<ListObjectResult$1[]>;
+    listAllFile(): Promise<ListFileObject[]>;
+    listAll(): Promise<ListObjectResult[]>;
     configMap: Map<string, any>;
     keys: string[];
-    getAllConfigJson(): Promise<ListFileObject$1[]>;
+    getAllConfigJson(): Promise<ListFileObject[]>;
     isEndWithJson(string: string): boolean;
-    putJsonObject(key: string, data: any): Promise<UploadedObjectInfo$1>;
+    putJsonObject(key: string, data: any): Promise<UploadedObjectInfo>;
     getObjectList(objectNameList: string[]): Promise<Map<string, Record<string, any>>>;
     getList(): Promise<{
         list: {
@@ -287,31 +293,13 @@ declare class ConfigOssService extends OssBase implements OssService$1 {
             size: number;
             lastModified: Date;
             etag: string;
+            metaData?: ItemBucketMetadata;
         }[];
         keys: string[];
         keyEtagMap: Map<string, string>;
     }>;
 }
 
-/**
- * 过滤 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<_aws_sdk_client_s3.GetObjectCommandOutput>;
-
 /**
  * 计算字符串的md5值
  * @param str
@@ -341,88 +329,5 @@ declare function extractStandardHeaders(metaData: Record<string, string>): {
     customMetadata: Record<string, string>;
 };
 
-type UploadedObjectInfo = {
-    etag: string;
-    lastModified?: Date;
-    size?: number;
-    versionId: string;
-    metadata?: ItemBucketMetadata$1;
-};
-type StatObjectResult = {
-    size: number;
-    etag: string;
-    lastModified: Date;
-    metaData: ItemBucketMetadata$1;
-    versionId?: string | null;
-};
-type ListFileObject = {
-    name: string;
-    size: number;
-    lastModified: Date;
-    etag: string;
-};
-type ListDirectoryObject = {
-    prefix: string;
-    size: number;
-};
-type ListObjectResult = ListFileObject | ListDirectoryObject;
-interface OssBaseOperation {
-    prefix: string;
-    setPrefix(prefix: string): void;
-    /**
-     * 获取对象
-     * @param objectName 对象名
-     */
-    getObject(objectName: string): Promise<any>;
-    /**
-     * 上传对象
-     * @param objectName 对象名
-     * @param data 数据
-     */
-    putObject(objectName: string, data: Buffer | string, metaData?: ItemBucketMetadata$1): Promise<UploadedObjectInfo>;
-    /**
-     * 上传文件
-     * @param objectName 对象名
-     * @param filePath 文件路径
-     */
-    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata$1): Promise<UploadedObjectInfo>;
-    /**
-     * 获取对象信息
-     * @param objectName 对象名
-     */
-    statObject(objectName: string): Promise<StatObjectResult>;
-    /**
-     * 删除对象
-     * @param objectName 对象名
-     */
-    deleteObject(objectName: string): Promise<any>;
-    /**
-     * 列出对象
-     * @param objectName 对象名
-     * @param opts 选项
-     * @param opts.recursive 是否递归
-     * @param opts.startAfter 开始位置
-     */
-    listObjects(objectName: string, opts?: {
-        /**
-         * 是否递归
-         */
-        recursive?: boolean;
-        /**
-         * 开始位置
-         */
-        startAfter?: string;
-    }): Promise<ListObjectResult[]>;
-    /**
-     * 复制对象
-     * @param sourceObject 源对象
-     * @param targetObject 目标对象
-     */
-    copyObject: Client['copyObject'];
-}
-interface OssService extends OssBaseOperation {
-    owner: string;
-}
-
-export { ConfigOssService, NotFoundFile, OssBase, downloadObject, extractStandardHeaders, filterMetaDataKeys, getContentType, hash, hashSringify, sendObject, standardHeaderKeys };
-export type { ListDirectoryObject, ListFileObject, ListObjectResult, OssBaseOperation, OssBaseOptions, OssService, StandardHeaders, StatObjectResult, UploadedObjectInfo };
+export { ConfigOssService, OssBase, extractStandardHeaders, getContentType, hash, hashSringify, standardHeaderKeys };
+export type { ItemBucketMetadata, ListDirectoryObject, ListFileObject, ListObjectResult, OssBaseOperation, OssBaseOptions, OssService, StandardHeaders, StatObjectResult, UploadedObjectInfo };