@kevisual/oss 0.0.15 → 0.0.17

package/dist/services/index.d.ts

@@ -1,235 +0,0 @@
-// Generated by dts-bundle-generator v9.5.1
-
-import { Client, ItemBucketMetadata } from 'minio';
-import { ServerResponse } from 'node:http';
-
-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 interface OssService extends OssBaseOperation {
-	owner: string;
-}
-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("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;
-}
-export 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<import("node_modules/minio/dist/main/internal/type.js").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>;
-	}>;
-}
-/**
- * 过滤 metaData 中的 key, 去除 password, accesskey, secretkey，
- * 并返回过滤后的 metaData
- * @param metaData
- * @returns
- */
-export declare const filterMetaDataKeys: (metaData: Record<string, string>, clearKeys?: string[]) => Record<string, string>;
-export type SendObjectOptions = {
-	res: ServerResponse;
-	client: OssBase;
-	objectName: string;
-	isDownload?: boolean;
-};
-export declare const NotFoundFile: (res: ServerResponse, msg?: string, code?: number) => void;
-export declare const sendObject: ({ res, objectName, client, isDownload }: SendObjectOptions) => Promise<void>;
-export declare const downloadObject: ({ objectName, client, filePath }: Pick<SendObjectOptions, "objectName" | "client"> & {
-	filePath: string;
-}) => Promise<import("node:stream").Readable>;
-/**
- * 计算字符串的md5值
- * @param str
- * @returns
- */
-export declare const hash: (str: string | Buffer | Object) => string;
-export declare const hashSringify: (str: Object) => string;
-export declare const getContentType: (filePath: string) => any;
-export declare const standardHeaderKeys: string[];
-export type StandardHeaders = {
-	ContentType?: string;
-	CacheControl?: string;
-	ContentDisposition?: string;
-	ContentEncoding?: string;
-	ContentLanguage?: string;
-	Expires?: Date;
-};
-/**
- * 从元数据中提取标准头部和自定义元数据
- * @param metaData 原始元数据
- * @returns 标准头部和自定义元数据
- */
-export declare function extractStandardHeaders(metaData: Record<string, string>): {
-	standardHeaders: StandardHeaders;
-	customMetadata: Record<string, string>;
-};
-
-export {};

package/dist/services/index.js

@@ -1,421 +0,0 @@
-// src/util/hash.ts
-import crypto from "node:crypto";
-var hash = (str) => {
-  let hashStr;
-  if (str instanceof Buffer) {
-    hashStr = str;
-  } else if (str instanceof Object) {
-    hashStr = JSON.stringify(str, null, 2);
-  } else {
-    hashStr = str;
-  }
-  return crypto.createHash("md5").update(hashStr).digest("hex");
-};
-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/util/get-content-type.ts
-import path from "node:path";
-var getContentType = (filePath) => {
-  const extname = path.extname(filePath);
-  const contentType = {
-    ".html": "text/html; charset=utf-8",
-    ".js": "text/javascript; charset=utf-8",
-    ".css": "text/css; charset=utf-8",
-    ".txt": "text/plain; charset=utf-8",
-    ".json": "application/json; charset=utf-8",
-    ".png": "image/png",
-    ".jpg": "image/jpg",
-    ".gif": "image/gif",
-    ".svg": "image/svg+xml",
-    ".wav": "audio/wav",
-    ".mp4": "video/mp4",
-    ".md": "text/markdown; charset=utf-8",
-    ".ico": "image/x-icon",
-    ".webp": "image/webp",
-    ".webm": "video/webm",
-    ".ogg": "audio/ogg",
-    ".mp3": "audio/mpeg",
-    ".m4a": "audio/mp4",
-    ".m3u8": "application/vnd.apple.mpegurl",
-    ".ts": "video/mp2t",
-    ".pdf": "application/pdf",
-    ".doc": "application/msword",
-    ".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-    ".ppt": "application/vnd.ms-powerpoint",
-    ".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
-    ".xls": "application/vnd.ms-excel",
-    ".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
-    ".csv": "text/csv; charset=utf-8",
-    ".xml": "application/xml; charset=utf-8",
-    ".rtf": "application/rtf",
-    ".eot": "application/vnd.ms-fontobject",
-    ".ttf": "font/ttf",
-    ".woff": "font/woff",
-    ".woff2": "font/woff2",
-    ".otf": "font/otf",
-    ".wasm": "application/wasm",
-    ".pem": "application/x-pem-file",
-    ".crt": "application/x-x509-ca-cert",
-    ".yaml": "application/x-yaml; charset=utf-8",
-    ".yml": "application/x-yaml; charset=utf-8",
-    ".zip": "application/octet-stream"
-  };
-  return contentType[extname] || "application/octet-stream";
-};
-
-// node_modules/.pnpm/es-toolkit@1.43.0/node_modules/es-toolkit/dist/object/omit.mjs
-function omit(obj, keys) {
-  const result = { ...obj };
-  for (let i = 0;i < keys.length; i++) {
-    const key = keys[i];
-    delete result[key];
-  }
-  return result;
-}
-// src/index.ts
-class OssBase {
-  client;
-  bucketName;
-  prefix = "";
-  hash = hash;
-  constructor(opts) {
-    if (!opts.client) {
-      throw new Error("client is required");
-    }
-    this.bucketName = opts.bucketName;
-    this.client = opts.client;
-    this.prefix = opts?.prefix ?? "";
-  }
-  setPrefix(prefix) {
-    this.prefix = prefix;
-  }
-  async getObject(objectName) {
-    const bucketName = this.bucketName;
-    const obj = await this.client.getObject(bucketName, `${this.prefix}${objectName}`);
-    return obj;
-  }
-  async getJson(objectName) {
-    const obj = await this.getObject(objectName);
-    return new Promise((resolve, reject) => {
-      let data = "";
-      obj.on("data", (chunk) => {
-        data += chunk;
-      });
-      obj.on("end", () => {
-        try {
-          const jsonData = JSON.parse(data);
-          resolve(jsonData);
-        } catch (error) {
-          reject(new Error("Failed to parse JSON"));
-        }
-      });
-      obj.on("error", (err) => {
-        reject(err);
-      });
-    });
-  }
-  async putObject(objectName, data, metaData = {}, opts) {
-    let putData;
-    let size = opts?.size;
-    const isStream = opts?.isStream;
-    if (!isStream) {
-      if (typeof data === "string") {
-        putData = data;
-        size = putData.length;
-      } else {
-        putData = JSON.stringify(data);
-        size = putData.length;
-      }
-    } else {
-      putData = data;
-      if (!size) {
-        throw new Error("Stream upload requires size parameter to avoid multipart upload and get standard MD5 ETag");
-      }
-    }
-    if (opts?.check) {
-      const obj2 = await this.statObject(objectName, true);
-      if (obj2) {
-        const omitMeda = ["size", "content-type", "cache-control", "app-source"];
-        const objMeta = JSON.parse(JSON.stringify(omit(obj2.metaData, omitMeda)));
-        metaData = {
-          ...objMeta,
-          ...metaData
-        };
-      }
-    }
-    const bucketName = this.bucketName;
-    const obj = await this.client.putObject(bucketName, `${this.prefix}${objectName}`, putData, size, metaData);
-    return obj;
-  }
-  async deleteObject(objectName) {
-    const bucketName = this.bucketName;
-    const obj = await this.client.removeObject(bucketName, `${this.prefix}${objectName}`);
-    return obj;
-  }
-  async listObjects(objectName, opts) {
-    const bucketName = this.bucketName;
-    const prefix = `${this.prefix}${objectName}`;
-    const res = await new Promise((resolve, reject) => {
-      let res2 = [];
-      let hasError = false;
-      this.client.listObjectsV2(bucketName, prefix, opts?.recursive ?? false, opts?.startAfter).on("data", (data) => {
-        res2.push(data);
-      }).on("error", (err) => {
-        console.error("minio error", prefix, err);
-        hasError = true;
-      }).on("end", () => {
-        if (hasError) {
-          reject();
-          return;
-        } else {
-          resolve(res2);
-        }
-      });
-    });
-    return res;
-  }
-  async fPutObject(objectName, filePath, metaData) {
-    const bucketName = this.bucketName;
-    const obj = await this.client.fPutObject(bucketName, `${this.prefix}${objectName}`, filePath, metaData);
-    return obj;
-  }
-  async getObjectName(objectName) {
-    return `${this.prefix}${objectName}`;
-  }
-  async statObject(objectName, checkFile = true) {
-    const bucketName = this.bucketName;
-    try {
-      const obj = await this.client.statObject(bucketName, `${this.prefix}${objectName}`);
-      return obj;
-    } catch (e) {
-      if (e.code === "NotFound") {
-        return null;
-      }
-      throw e;
-    }
-  }
-  async checkObjectHash(objectName, hash2, meta) {
-    const obj = await this.statObject(`${this.prefix}${objectName}`, true);
-    if (!obj) {
-      return { success: false, metaData: null, obj: null, equalMeta: false };
-    }
-    let metaData = {};
-    const omitMeda = ["content-type", "cache-control", "app-source"];
-    const objMeta = omit(obj.metaData, omitMeda);
-    metaData = {
-      ...objMeta
-    };
-    let equalMeta = false;
-    if (meta) {
-      equalMeta = JSON.stringify(metaData) === JSON.stringify(meta);
-    }
-    return { success: obj.etag === hash2, metaData, obj, equalMeta };
-  }
-  getMetadata(pathname, meta = { "app-source": "user-app" }) {
-    const isHtml = pathname.endsWith(".html");
-    if (isHtml) {
-      meta = {
-        ...meta,
-        "content-type": "text/html; charset=utf-8",
-        "cache-control": "no-cache"
-      };
-    } else {
-      meta = {
-        ...meta,
-        "content-type": getContentType(pathname),
-        "cache-control": "max-age=31536000, immutable"
-      };
-    }
-    return meta;
-  }
-  async copyObject(sourceObject, targetObject) {
-    const bucketName = this.bucketName;
-    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);
-  }
-  static fromBase(createOpts) {
-    const base = createOpts.oss;
-    const opts = createOpts.opts;
-    return new this({
-      client: base.client,
-      bucketName: base.bucketName,
-      ...opts
-    });
-  }
-}
-// src/util/extract-standard-headers.ts
-var standardHeaderKeys = ["content-type", "cache-control", "content-disposition", "content-encoding", "content-language", "expires"];
-function extractStandardHeaders(metaData) {
-  const standardHeaders = {};
-  const customMetadata = {};
-  for (const [key, value] of Object.entries(metaData)) {
-    const lowerKey = key.toLowerCase();
-    if (lowerKey === "content-type") {
-      standardHeaders.ContentType = value;
-    } else if (lowerKey === "cache-control") {
-      standardHeaders.CacheControl = value;
-    } else if (lowerKey === "content-disposition") {
-      standardHeaders.ContentDisposition = value;
-    } else if (lowerKey === "content-encoding") {
-      standardHeaders.ContentEncoding = value;
-    } else if (lowerKey === "content-language") {
-      standardHeaders.ContentLanguage = value;
-    } else if (lowerKey === "expires") {
-      standardHeaders.Expires = new Date(value);
-    } else {
-      customMetadata[key] = value;
-    }
-  }
-  return { standardHeaders, customMetadata };
-}
-// src/services/config.ts
-class ConfigOssService extends OssBase {
-  owner;
-  constructor(opts) {
-    super(opts);
-    this.owner = opts.owner;
-    this.setPrefix(`${this.owner}/config/1.0.0/`);
-  }
-  async listAllFile() {
-    const list = await this.listObjects("");
-    return list.filter((item) => item.size > 0 && this.isEndWithJson(item.name));
-  }
-  async listAll() {
-    return await this.listObjects("");
-  }
-  configMap = new Map;
-  keys = [];
-  async getAllConfigJson() {
-    const list = await this.listAllFile();
-    return list;
-  }
-  isEndWithJson(string) {
-    return string?.endsWith?.(`.json`);
-  }
-  putJsonObject(key, data) {
-    const json = hashSringify(data);
-    return this.putObject(key, json, {
-      "Content-Type": "application/json",
-      "app-source": "user-config-app",
-      "Cache-Control": "max-age=31536000, immutable"
-    });
-  }
-  async getObjectList(objectNameList) {
-    const jsonMap = new Map;
-    for (const objectName of objectNameList) {
-      try {
-        const json = await this.getJson(objectName);
-        jsonMap.set(objectName, json);
-      } catch (error) {
-        console.error(error);
-        continue;
-      }
-    }
-    return jsonMap;
-  }
-  async getList() {
-    const list = await this.listAllFile();
-    const keyEtagMap = new Map;
-    const listKeys = list.map((item) => {
-      const key = item.name.replace(this.prefix, "");
-      keyEtagMap.set(key, item.etag);
-      return {
-        ...item,
-        key
-      };
-    });
-    const keys = Array.from(keyEtagMap.keys());
-    return { list: listKeys, keys, keyEtagMap };
-  }
-}
-// src/util/download.ts
-import fs from "node:fs";
-import path2 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,
-      ...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 = path2.dirname(filePath);
-  if (!fs.existsSync(dir)) {
-    fs.mkdirSync(dir, { recursive: true });
-  }
-  objectStream.pipe(fs.createWriteStream(filePath));
-  return objectStream;
-};
-export {
-  standardHeaderKeys,
-  sendObject,
-  hashSringify,
-  hash,
-  getContentType,
-  filterMetaDataKeys,
-  extractStandardHeaders,
-  downloadObject,
-  OssBase,
-  NotFoundFile,
-  ConfigOssService
-};