@kevisual/oss 0.0.1

package/dist/index-BNtwSChY.d.ts

@@ -0,0 +1,133 @@
+import * as minio from 'minio';
+import { ItemBucketMetadata, Client } from 'minio';
+import * as minio_dist_esm_internal_type_mjs from 'minio/dist/esm/internal/type.mjs';
+import * as stream from 'stream';
+
+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;
+};
+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): 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'];
+}
+interface OssService extends OssBaseOperation {
+    owner: string;
+}
+
+type OssBaseOptions<T = {
+    [key: string]: any;
+}> = {
+    /**
+     * 已经初始化好的minio client
+     */
+    client?: Client;
+    /**
+     * 桶名
+     */
+    bucketName: string;
+    /**
+     * 前缀
+     */
+    prefix?: string;
+} & T;
+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<stream.Readable>;
+    getJson(objectName: string): Promise<Record<string, any>>;
+    putObject(objectName: string, data: Buffer | string | Object, metaData?: ItemBucketMetadata): Promise<minio_dist_esm_internal_type_mjs.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>;
+    statObject(objectName: string): Promise<minio.BucketItemStat>;
+    copyObject(sourceObject: any, targetObject: any): Promise<minio_dist_esm_internal_type_mjs.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 { type ListFileObject as L, OssBase as O, type OssService as a, type OssBaseOptions as b, type ListObjectResult as c };

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import 'minio';
+import 'minio/dist/esm/internal/type.mjs';
+import 'stream';
+export { O as OssBase, b as OssBaseOptions } from './index-BNtwSChY.js';

package/dist/index.js

@@ -0,0 +1,134 @@
+// src/util/hash.ts
+import crypto from "crypto";
+var hash = (str) => {
+  let hashStr;
+  if (typeof str === "object") {
+    hashStr = JSON.stringify(str, null, 2);
+  } else {
+    hashStr = str;
+  }
+  return crypto.createHash("md5").update(hashStr).digest("hex");
+};
+
+// src/index.ts
+var OssBase = class {
+  client;
+  bucketName;
+  prefix = "";
+  /**
+   * 计算字符串或者对象的的md5值
+   */
+  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) {
+    let putData;
+    if (typeof data === "object") {
+      putData = JSON.stringify(data);
+    } else {
+      putData = data;
+    }
+    const size = putData.length;
+    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 statObject(objectName) {
+    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 copyObject(sourceObject, targetObject) {
+    const bucketName = this.bucketName;
+    const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
+    return obj;
+  }
+  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
+    });
+  }
+};
+export {
+  OssBase
+};

package/dist/services/config.d.ts

@@ -0,0 +1,32 @@
+import { O as OssBase, a as OssService, b as OssBaseOptions, L as ListFileObject, c as ListObjectResult } from '../index-BNtwSChY.js';
+import * as minio_dist_esm_internal_type_mjs from 'minio/dist/esm/internal/type.mjs';
+import 'minio';
+import 'stream';
+
+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<minio_dist_esm_internal_type_mjs.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>;
+    }>;
+}
+
+export { ConfigOssService };

package/dist/services/config.js

@@ -0,0 +1,198 @@
+// src/util/hash.ts
+import crypto from "crypto";
+var hash = (str) => {
+  let hashStr;
+  if (typeof str === "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/index.ts
+var OssBase = class {
+  client;
+  bucketName;
+  prefix = "";
+  /**
+   * 计算字符串或者对象的的md5值
+   */
+  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) {
+    let putData;
+    if (typeof data === "object") {
+      putData = JSON.stringify(data);
+    } else {
+      putData = data;
+    }
+    const size = putData.length;
+    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 statObject(objectName) {
+    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 copyObject(sourceObject, targetObject) {
+    const bucketName = this.bucketName;
+    const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
+    return obj;
+  }
+  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/services/config.ts
+var ConfigOssService = class 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 = /* @__PURE__ */ 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 = /* @__PURE__ */ 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 = /* @__PURE__ */ 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 };
+  }
+};
+export {
+  ConfigOssService
+};

package/dist/services/index.d.ts

@@ -0,0 +1,5 @@
+export { O as OssBase, b as OssBaseOptions } from '../index-BNtwSChY.js';
+export { ConfigOssService } from './config.js';
+import 'minio';
+import 'minio/dist/esm/internal/type.mjs';
+import 'stream';

package/dist/services/index.js

@@ -0,0 +1,199 @@
+// src/util/hash.ts
+import crypto from "crypto";
+var hash = (str) => {
+  let hashStr;
+  if (typeof str === "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/index.ts
+var OssBase = class {
+  client;
+  bucketName;
+  prefix = "";
+  /**
+   * 计算字符串或者对象的的md5值
+   */
+  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) {
+    let putData;
+    if (typeof data === "object") {
+      putData = JSON.stringify(data);
+    } else {
+      putData = data;
+    }
+    const size = putData.length;
+    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 statObject(objectName) {
+    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 copyObject(sourceObject, targetObject) {
+    const bucketName = this.bucketName;
+    const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
+    return obj;
+  }
+  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/services/config.ts
+var ConfigOssService = class 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 = /* @__PURE__ */ 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 = /* @__PURE__ */ 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 = /* @__PURE__ */ 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 };
+  }
+};
+export {
+  ConfigOssService,
+  OssBase
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@kevisual/oss",
+  "version": "0.0.1",
+  "description": "",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "dev:lib": "tsup --watch"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": "abearxiong <xiongxiao@xiongxiao.me>",
+  "license": "MIT",
+  "type": "module",
+  "devDependencies": {
+    "dotenv": "^16.4.7",
+    "minio": "^8.0.5",
+    "tsup": "^8.4.0"
+  },
+  "exports": {
+    "./*": "./dist/*.js",
+    "./services": "./dist/services/index.js"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/readme.md

@@ -0,0 +1,9 @@
+# oss 管理，对minio的封装
+
+一般常用的功能模块。
+
+- 上传文件
+- 下载文件
+- 删除文件
+- 复制文件
+- 列出文件