@kevisual/oss 0.0.15 → 0.0.17

package/dist/index.d.ts

@@ -1,162 +1,265 @@
-// Generated by dts-bundle-generator v9.5.1
+import { CopyObjectCommandOutput, S3Client, GetObjectCommandOutput } from '@aws-sdk/client-s3';
+import { Readable } from 'node:stream';
 
-import { Client, ItemBucketMetadata } from 'minio';
-
-export type UploadedObjectInfo = {
-	etag: string;
-	lastModified?: Date;
-	size?: number;
-	versionId: string;
-	metadata?: ItemBucketMetadata;
+type ItemBucketMetadata = Record<string, string>;
+type UploadedObjectInfo = {
+    etag: string;
+    lastModified?: Date;
+    size?: number;
+    versionId: string;
+    metadata?: ItemBucketMetadata;
 };
-export type StatObjectResult = {
-	size: number;
-	etag: string;
-	lastModified: Date;
-	metaData: ItemBucketMetadata;
-	versionId?: string | null;
+type StatObjectResult = {
+    size: number;
+    etag: string;
+    lastModified: Date;
+    metaData: ItemBucketMetadata;
+    versionId?: string | null;
 };
-export type ListFileObject = {
-	name: string;
-	size: number;
-	lastModified: Date;
-	etag: string;
+type ListFileObject = {
+    name: string;
+    size: number;
+    lastModified: Date;
+    etag: string;
 };
-export type ListDirectoryObject = {
-	prefix: string;
-	size: number;
+type ListDirectoryObject = {
+    prefix: string;
+    size: number;
 };
-export type ListObjectResult = ListFileObject | ListDirectoryObject;
-export 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): Promise<UploadedObjectInfo>;
-	/**
-	 * 上传文件
-	 * @param objectName 对象名
-	 * @param filePath 文件路径
-	 */
-	fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): 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"];
+type ListObjectResult = ListFileObject | ListDirectoryObject;
+interface OssBaseOperation {
+    prefix: string;
+    /**
+     * 设置前缀
+     * @param prefix 前缀
+     */
+    setPrefix(prefix: string): void;
+    /**
+     * 获取对象
+     * @param objectName 对象名
+     */
+    getObject(objectName: string): Promise<any>;
+    /**
+     * 获取对象内容为字符串
+     * @param objectName 对象名
+     */
+    getObjectAsString?(objectName: string): Promise<string>;
+    /**
+     * 获取对象内容为 JSON
+     * @param objectName 对象名
+     */
+    getJson?(objectName: string): Promise<Record<string, any>>;
+    /**
+     * 上传对象
+     * @param objectName 对象名
+     * @param data 数据
+     * @param metaData 元数据
+     * @param opts 选项
+     */
+    putObject(objectName: string, data: Buffer | string | Object | Readable, metaData?: ItemBucketMetadata, opts?: {
+        check?: boolean;
+        isStream?: boolean;
+        size?: number;
+        contentType?: string;
+    }): Promise<UploadedObjectInfo>;
+    /**
+     * 上传文件
+     * @param objectName 对象名
+     * @param filePath 文件路径
+     * @param metaData 元数据
+     */
+    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
+    /**
+     * 获取对象信息
+     * @param objectName 对象名
+     * @param checkFile 是否检查文件存在（不存在返回null而非抛错）
+     */
+    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult | null>;
+    /**
+     * 删除对象
+     * @param objectName 对象名
+     */
+    deleteObject(objectName: string): Promise<any>;
+    /**
+     * 列出对象
+     * @param objectName 前缀
+     * @param opts 选项
+     */
+    listObjects(objectName: string, opts?: {
+        /** 是否递归 */
+        recursive?: boolean;
+        /** 开始位置 */
+        startAfter?: string;
+        /** 最大返回数量 */
+        maxKeys?: number;
+    }): Promise<ListObjectResult[]>;
+    /**
+     * 获取完整的对象名称
+     * @param objectName 对象名
+     */
+    getObjectName?(objectName: string): string;
+    /**
+     * 检查文件hash是否一致
+     * @param objectName 对象名
+     * @param hash hash值
+     * @param meta 元数据
+     */
+    checkObjectHash?(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
+        success: boolean;
+        metaData: ItemBucketMetadata | null;
+        obj: StatObjectResult | null;
+        equalMeta?: boolean;
+    }>;
+    /**
+     * 获取元数据
+     * @param pathname 路径名
+     * @param meta 元数据
+     */
+    getMetadata?(pathname: string, meta?: ItemBucketMetadata): ItemBucketMetadata;
+    /**
+     * 复制对象
+     * @param sourceObject 源对象
+     * @param targetObject 目标对象
+     */
+    copyObject(sourceObject: string, targetObject: string): Promise<CopyObjectCommandOutput>;
+    /**
+     * 替换对象元数据
+     * @param objectName 对象名
+     * @param meta 新元数据
+     */
+    replaceObject?(objectName: string, meta: ItemBucketMetadata): Promise<any>;
 }
-export type OssBaseOptions<T = {
-	[key: string]: any;
+
+type OssBaseOptions<T = {
+    [key: string]: any;
 }> = {
-	/**
-	 * 已经初始化好的minio client
-	 */
-	client: Client;
-	/**
-	 * 桶名
-	 */
-	bucketName: string;
-	/**
-	 * 前缀
-	 */
-	prefix?: string;
+    /**
+     * 已经初始化好的 S3Client
+     */
+    client: S3Client;
+    /**
+     * 桶名
+     */
+    bucketName: string;
+    /**
+     * 前缀
+     */
+    prefix?: string;
 } & T;
-export declare class OssBase implements OssBaseOperation {
-	client?: Client;
-	bucketName: string;
-	prefix: string;
-	/**
-	 * 计算字符串或者对象的的md5值
-	 */
-	hash: (str: string | Buffer | Object) => string;
-	constructor(opts: OssBaseOptions);
-	setPrefix(prefix: string): void;
-	getObject(objectName: string): Promise<import("node:stream").Readable>;
-	getJson(objectName: string): Promise<Record<string, any>>;
-	/**
-	 * 上传文件, 当是流的时候，中断之后的etag会变，所以传递的时候不要嵌套async await，例如 busboy 监听文件流内部的时候，不要用check
-	 * @param objectName
-	 * @param data
-	 * @param metaData
-	 * @param options 如果文件本身存在，则复制原有的meta的内容
-	 * @returns
-	 */
-	putObject(objectName: string, data: Buffer | string | Object, metaData?: ItemBucketMetadata, opts?: {
-		check?: boolean;
-		isStream?: boolean;
-		size?: number;
-	}): Promise<import("node_modules/minio/dist/main/internal/type.js").UploadedObjectInfo>;
-	deleteObject(objectName: string): Promise<void>;
-	listObjects<IS_FILE = false>(objectName: string, opts?: {
-		recursive?: boolean;
-		startAfter?: string;
-	}): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
-	fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<any>;
-	/**
-	 * 获取完整的对象名称
-	 * @param objectName
-	 * @returns
-	 */
-	getObjectName(objectName: string): Promise<string>;
-	statObject(objectName: string, checkFile?: boolean): Promise<import("minio").BucketItemStat>;
-	/**
-	 * 检查文件hash是否一致
-	 * @param objectName
-	 * @param hash
-	 * @returns
-	 */
-	checkObjectHash(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
-		success: boolean;
-		metaData: ItemBucketMetadata | null;
-		obj: any;
-		equalMeta?: boolean;
-	}>;
-	getMetadata(pathname: string, meta?: ItemBucketMetadata): ItemBucketMetadata;
-	copyObject(sourceObject: any, targetObject: any): Promise<import("node_modules/minio/dist/main/internal/type.js").CopyObjectResult>;
-	replaceObject(objectName: string, meta: {
-		[key: string]: string;
-	}): Promise<import("node_modules/minio/dist/main/internal/type.js").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;
-		opts: Partial<OssBaseOptions<U>>;
-	}): T;
+declare class OssBase implements OssBaseOperation {
+    client: S3Client;
+    bucketName: string;
+    prefix: string;
+    /**
+     * 计算字符串或者对象的的md5值
+     */
+    hash: (str: string | Buffer | Object) => string;
+    constructor(opts: OssBaseOptions);
+    setPrefix(prefix: string): void;
+    /**
+     * 获取对象
+     * @param objectName 对象名
+     */
+    getObject(objectName: string): Promise<GetObjectCommandOutput>;
+    /**
+     * 获取对象内容为字符串
+     * @param objectName 对象名
+     */
+    getObjectAsString(objectName: string): Promise<string>;
+    /**
+     * 获取对象内容为 JSON
+     * @param objectName 对象名
+     */
+    getJson(objectName: string): Promise<Record<string, any>>;
+    /**
+     * 上传对象
+     * @param objectName 对象名
+     * @param data 数据
+     * @param metaData 元数据
+     * @param opts 选项
+     */
+    putObject(objectName: string, data: Buffer | string | Object | Readable, metaData?: ItemBucketMetadata, opts?: {
+        check?: boolean;
+        isStream?: boolean;
+        size?: number;
+        contentType?: string;
+    }): Promise<UploadedObjectInfo>;
+    /**
+     * 上传文件
+     * @param objectName 对象名
+     * @param filePath 文件路径
+     * @param metaData 元数据
+     */
+    fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
+    /**
+     * 删除对象
+     * @param objectName 对象名
+     */
+    deleteObject(objectName: string): Promise<void>;
+    deleteObjects(objectNameList: string[]): Promise<void>;
+    /**
+     * 列出对象
+     * @param objectName 前缀
+     * @param opts 选项
+     */
+    listObjects<IS_FILE = false>(objectName: string, opts?: {
+        recursive?: boolean;
+        startAfter?: string;
+        maxKeys?: number;
+    }): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
+    /**
+     * 获取对象信息
+     * @param objectName 对象名
+     * @param checkFile 是否检查文件存在（不存在返回null而非抛错）
+     */
+    statObject(objectName: string, checkFile?: boolean): Promise<StatObjectResult | null>;
+    /**
+     * 获取完整的对象名称
+     * @param objectName 对象名
+     */
+    getObjectName(objectName: string): string;
+    /**
+     * 检查文件hash是否一致
+     * @param objectName 对象名
+     * @param hash hash值
+     * @param meta 元数据
+     */
+    checkObjectHash(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
+        success: boolean;
+        metaData: ItemBucketMetadata | null;
+        obj: StatObjectResult | null;
+        equalMeta?: boolean;
+    }>;
+    /**
+     * 获取元数据
+     * @param pathname 路径名
+     * @param meta 元数据
+     */
+    getMetadata(pathname: string, meta?: ItemBucketMetadata): ItemBucketMetadata;
+    /**
+     * 复制对象
+     * @param sourceObject 源对象
+     * @param targetObject 目标对象
+     */
+    copyObject(sourceObject: string, targetObject: string): Promise<any>;
+    /**
+     * 替换对象元数据
+     * @param objectName 对象名
+     * @param meta 新元数据
+     */
+    replaceObject(objectName: string, meta: ItemBucketMetadata): Promise<any>;
+    /**
+     * 创建实例
+     */
+    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;
+        opts: Partial<OssBaseOptions<U>>;
+    }): T;
 }
 
-export {};
+export { OssBase };
+export type { OssBaseOptions };