@kevisual/oss 0.0.12 → 0.0.13

package/dist/index.d.ts

@@ -1,4 +1,162 @@
-import 'minio';
-import 'minio/dist/esm/internal/type.mjs';
-import 'stream';
-export { O as OssBase, a as OssBaseOptions } from './index-BGsBfWH-.js';
+// Generated by dts-bundle-generator v9.5.1
+
+import { Client, ItemBucketMetadata } from 'minio';
+
+export 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;
+};
+export type ListFileObject = {
+	name: string;
+	size: number;
+	lastModified: Date;
+	etag: string;
+};
+export 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"];
+}
+export type OssBaseOptions<T = {
+	[key: string]: any;
+}> = {
+	/**
+	 * 已经初始化好的minio client
+	 */
+	client: Client;
+	/**
+	 * 桶名
+	 */
+	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("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;
+}
+
+export {};