@kevisual/oss 0.0.16 → 0.0.18

package/dist/services.d.ts

@@ -0,0 +1,330 @@
+import { CopyObjectCommandOutput, S3Client, GetObjectCommandOutput } from '@aws-sdk/client-s3';
+import { Readable } from 'node:stream';
+
+type ItemBucketMetadata = Record<string, string>;
+type UploadedObjectInfo = {
+    etag: string;
+    lastModified?: Date;
+    size?: number;
+    versionId: string;
+    metadata?: ItemBucketMetadata;
+};
+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 = {
+    name: string;
+    size: number;
+    lastModified: Date;
+    etag: string;
+};
+type ListDirectoryObject = {
+    prefix: string;
+    size: number;
+};
+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>;
+}
+interface OssService extends OssBaseOperation {
+    owner: string;
+}
+
+type OssBaseOptions<T = {
+    [key: string]: any;
+}> = {
+    /**
+     * 已经初始化好的 S3Client
+     */
+    client: S3Client;
+    /**
+     * 桶名
+     */
+    bucketName: string;
+    /**
+     * 前缀
+     */
+    prefix?: string;
+} & 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;
+}
+
+declare class ConfigOssService extends OssBase implements OssService {
+    owner: string;
+    constructor(opts: OssBaseOptions<{
+        owner: string;
+    }>);
+    listAllFile(): Promise<ListFileObject[]>;
+    listAll(): Promise<ListObjectResult[]>;
+    configMap: Map<string, any>;
+    keys: string[];
+    getAllConfigJson(): Promise<ListFileObject[]>;
+    isEndWithJson(string: string): boolean;
+    putJsonObject(key: string, data: any): Promise<UploadedObjectInfo>;
+    getObjectList(objectNameList: string[]): Promise<Map<string, Record<string, any>>>;
+    getList(): Promise<{
+        list: {
+            key: string;
+            name: string;
+            size: number;
+            lastModified: Date;
+            etag: string;
+        }[];
+        keys: string[];
+        keyEtagMap: Map<string, string>;
+    }>;
+}
+
+/**
+ * 计算字符串的md5值
+ * @param str
+ * @returns
+ */
+declare const hash: (str: string | Buffer | Object) => string;
+declare const hashSringify: (str: Object) => string;
+
+declare const getContentType: (filePath: string) => any;
+
+declare const standardHeaderKeys: string[];
+type StandardHeaders = {
+    ContentType?: string;
+    CacheControl?: string;
+    ContentDisposition?: string;
+    ContentEncoding?: string;
+    ContentLanguage?: string;
+    Expires?: Date;
+};
+/**
+ * 从元数据中提取标准头部和自定义元数据
+ * @param metaData 原始元数据
+ * @returns 标准头部和自定义元数据
+ */
+declare function extractStandardHeaders(metaData: Record<string, string>): {
+    standardHeaders: StandardHeaders;
+    customMetadata: Record<string, string>;
+};
+
+export { ConfigOssService, OssBase, extractStandardHeaders, getContentType, hash, hashSringify, standardHeaderKeys };
+export type { ItemBucketMetadata, ListDirectoryObject, ListFileObject, ListObjectResult, OssBaseOperation, OssBaseOptions, OssService, StandardHeaders, StatObjectResult, UploadedObjectInfo };