@kevisual/oss 0.0.16 → 0.0.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,190 +0,0 @@
1
- // Generated by dts-bundle-generator v9.5.1
2
-
3
- import { Client, ItemBucketMetadata } from 'minio';
4
-
5
- export type UploadedObjectInfo = {
6
- etag: string;
7
- lastModified?: Date;
8
- size?: number;
9
- versionId: string;
10
- metadata?: ItemBucketMetadata;
11
- };
12
- export type StatObjectResult = {
13
- size: number;
14
- etag: string;
15
- lastModified: Date;
16
- metaData: ItemBucketMetadata;
17
- versionId?: string | null;
18
- };
19
- export type ListFileObject = {
20
- name: string;
21
- size: number;
22
- lastModified: Date;
23
- etag: string;
24
- };
25
- export type ListDirectoryObject = {
26
- prefix: string;
27
- size: number;
28
- };
29
- export type ListObjectResult = ListFileObject | ListDirectoryObject;
30
- export interface OssBaseOperation {
31
- prefix: string;
32
- setPrefix(prefix: string): void;
33
- /**
34
- * 获取对象
35
- * @param objectName 对象名
36
- */
37
- getObject(objectName: string): Promise<any>;
38
- /**
39
- * 上传对象
40
- * @param objectName 对象名
41
- * @param data 数据
42
- */
43
- putObject(objectName: string, data: Buffer | string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
44
- /**
45
- * 上传文件
46
- * @param objectName 对象名
47
- * @param filePath 文件路径
48
- */
49
- fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<UploadedObjectInfo>;
50
- /**
51
- * 获取对象信息
52
- * @param objectName 对象名
53
- */
54
- statObject(objectName: string): Promise<StatObjectResult>;
55
- /**
56
- * 删除对象
57
- * @param objectName 对象名
58
- */
59
- deleteObject(objectName: string): Promise<any>;
60
- /**
61
- * 列出对象
62
- * @param objectName 对象名
63
- * @param opts 选项
64
- * @param opts.recursive 是否递归
65
- * @param opts.startAfter 开始位置
66
- */
67
- listObjects(objectName: string, opts?: {
68
- /**
69
- * 是否递归
70
- */
71
- recursive?: boolean;
72
- /**
73
- * 开始位置
74
- */
75
- startAfter?: string;
76
- }): Promise<ListObjectResult[]>;
77
- /**
78
- * 复制对象
79
- * @param sourceObject 源对象
80
- * @param targetObject 目标对象
81
- */
82
- copyObject: Client["copyObject"];
83
- }
84
- export interface OssService extends OssBaseOperation {
85
- owner: string;
86
- }
87
- export type OssBaseOptions<T = {
88
- [key: string]: any;
89
- }> = {
90
- /**
91
- * 已经初始化好的minio client
92
- */
93
- client: Client;
94
- /**
95
- * 桶名
96
- */
97
- bucketName: string;
98
- /**
99
- * 前缀
100
- */
101
- prefix?: string;
102
- } & T;
103
- declare class OssBase implements OssBaseOperation {
104
- client?: Client;
105
- bucketName: string;
106
- prefix: string;
107
- /**
108
- * 计算字符串或者对象的的md5值
109
- */
110
- hash: (str: string | Buffer | Object) => string;
111
- constructor(opts: OssBaseOptions);
112
- setPrefix(prefix: string): void;
113
- getObject(objectName: string): Promise<import("node:stream").Readable>;
114
- getJson(objectName: string): Promise<Record<string, any>>;
115
- /**
116
- * 上传文件, 当是流的时候,中断之后的etag会变,所以传递的时候不要嵌套async await,例如 busboy 监听文件流内部的时候,不要用check
117
- * @param objectName
118
- * @param data
119
- * @param metaData
120
- * @param options 如果文件本身存在,则复制原有的meta的内容
121
- * @returns
122
- */
123
- putObject(objectName: string, data: Buffer | string | Object, metaData?: ItemBucketMetadata, opts?: {
124
- check?: boolean;
125
- isStream?: boolean;
126
- size?: number;
127
- }): Promise<import("node_modules/minio/dist/main/internal/type.js").UploadedObjectInfo>;
128
- deleteObject(objectName: string): Promise<void>;
129
- listObjects<IS_FILE = false>(objectName: string, opts?: {
130
- recursive?: boolean;
131
- startAfter?: string;
132
- }): Promise<IS_FILE extends true ? ListFileObject[] : ListObjectResult[]>;
133
- fPutObject(objectName: string, filePath: string, metaData?: ItemBucketMetadata): Promise<any>;
134
- /**
135
- * 获取完整的对象名称
136
- * @param objectName
137
- * @returns
138
- */
139
- getObjectName(objectName: string): Promise<string>;
140
- statObject(objectName: string, checkFile?: boolean): Promise<import("minio").BucketItemStat>;
141
- /**
142
- * 检查文件hash是否一致
143
- * @param objectName
144
- * @param hash
145
- * @returns
146
- */
147
- checkObjectHash(objectName: string, hash: string, meta?: ItemBucketMetadata): Promise<{
148
- success: boolean;
149
- metaData: ItemBucketMetadata | null;
150
- obj: any;
151
- equalMeta?: boolean;
152
- }>;
153
- getMetadata(pathname: string, meta?: ItemBucketMetadata): ItemBucketMetadata;
154
- copyObject(sourceObject: any, targetObject: any): Promise<import("node_modules/minio/dist/main/internal/type.js").CopyObjectResult>;
155
- replaceObject(objectName: string, meta: {
156
- [key: string]: string;
157
- }): Promise<import("node_modules/minio/dist/main/internal/type.js").CopyObjectResult>;
158
- static create<T extends OssBase, U>(this: new (opts: OssBaseOptions<U>) => T, opts: OssBaseOptions<U>): T;
159
- static fromBase<T extends OssBase, U>(this: new (opts: OssBaseOptions<U>) => T, createOpts: {
160
- oss: OssBase;
161
- opts: Partial<OssBaseOptions<U>>;
162
- }): T;
163
- }
164
- export declare class ConfigOssService extends OssBase implements OssService {
165
- owner: string;
166
- constructor(opts: OssBaseOptions<{
167
- owner: string;
168
- }>);
169
- listAllFile(): Promise<ListFileObject[]>;
170
- listAll(): Promise<ListObjectResult[]>;
171
- configMap: Map<string, any>;
172
- keys: string[];
173
- getAllConfigJson(): Promise<ListFileObject[]>;
174
- isEndWithJson(string: string): boolean;
175
- putJsonObject(key: string, data: any): Promise<import("node_modules/minio/dist/main/internal/type.js").UploadedObjectInfo>;
176
- getObjectList(objectNameList: string[]): Promise<Map<string, Record<string, any>>>;
177
- getList(): Promise<{
178
- list: {
179
- key: string;
180
- name: string;
181
- size: number;
182
- lastModified: Date;
183
- etag: string;
184
- }[];
185
- keys: string[];
186
- keyEtagMap: Map<string, string>;
187
- }>;
188
- }
189
-
190
- export {};
@@ -1,358 +0,0 @@
1
- // src/util/hash.ts
2
- import crypto from "node:crypto";
3
- var hash = (str) => {
4
- let hashStr;
5
- if (str instanceof Buffer) {
6
- hashStr = str;
7
- } else if (str instanceof Object) {
8
- hashStr = JSON.stringify(str, null, 2);
9
- } else {
10
- hashStr = str;
11
- }
12
- return crypto.createHash("md5").update(hashStr).digest("hex");
13
- };
14
- var hashSringify = (str) => {
15
- return JSON.stringify(str, null, 2);
16
- };
17
-
18
- // src/core/copy-object.ts
19
- import { CopyDestinationOptions, CopySourceOptions } from "minio";
20
- var copyObject = async ({ bucketName, newMetadata, objectName, client }) => {
21
- const source = new CopySourceOptions({ Bucket: bucketName, Object: objectName });
22
- const stat = await client.statObject(bucketName, objectName);
23
- const sourceMetadata = stat.metaData;
24
- const destination = new CopyDestinationOptions({
25
- Bucket: bucketName,
26
- Object: objectName,
27
- UserMetadata: { ...sourceMetadata, ...newMetadata },
28
- MetadataDirective: "REPLACE"
29
- });
30
- const copyResult = await client.copyObject(source, destination);
31
- return copyResult;
32
- };
33
-
34
- // src/util/get-content-type.ts
35
- import path from "node:path";
36
- var getContentType = (filePath) => {
37
- const extname = path.extname(filePath);
38
- const contentType = {
39
- ".html": "text/html; charset=utf-8",
40
- ".js": "text/javascript; charset=utf-8",
41
- ".css": "text/css; charset=utf-8",
42
- ".txt": "text/plain; charset=utf-8",
43
- ".json": "application/json; charset=utf-8",
44
- ".png": "image/png",
45
- ".jpg": "image/jpg",
46
- ".gif": "image/gif",
47
- ".svg": "image/svg+xml",
48
- ".wav": "audio/wav",
49
- ".mp4": "video/mp4",
50
- ".md": "text/markdown; charset=utf-8",
51
- ".ico": "image/x-icon",
52
- ".webp": "image/webp",
53
- ".webm": "video/webm",
54
- ".ogg": "audio/ogg",
55
- ".mp3": "audio/mpeg",
56
- ".m4a": "audio/mp4",
57
- ".m3u8": "application/vnd.apple.mpegurl",
58
- ".ts": "video/mp2t",
59
- ".pdf": "application/pdf",
60
- ".doc": "application/msword",
61
- ".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
62
- ".ppt": "application/vnd.ms-powerpoint",
63
- ".pptx": "application/vnd.openxmlformats-officedocument.presentationml.presentation",
64
- ".xls": "application/vnd.ms-excel",
65
- ".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
66
- ".csv": "text/csv; charset=utf-8",
67
- ".xml": "application/xml; charset=utf-8",
68
- ".rtf": "application/rtf",
69
- ".eot": "application/vnd.ms-fontobject",
70
- ".ttf": "font/ttf",
71
- ".woff": "font/woff",
72
- ".woff2": "font/woff2",
73
- ".otf": "font/otf",
74
- ".wasm": "application/wasm",
75
- ".pem": "application/x-pem-file",
76
- ".crt": "application/x-x509-ca-cert",
77
- ".yaml": "application/x-yaml; charset=utf-8",
78
- ".yml": "application/x-yaml; charset=utf-8",
79
- ".zip": "application/octet-stream"
80
- };
81
- return contentType[extname] || "application/octet-stream";
82
- };
83
-
84
- // node_modules/.pnpm/es-toolkit@1.43.0/node_modules/es-toolkit/dist/object/omit.mjs
85
- function omit(obj, keys) {
86
- const result = { ...obj };
87
- for (let i = 0;i < keys.length; i++) {
88
- const key = keys[i];
89
- delete result[key];
90
- }
91
- return result;
92
- }
93
- // src/index.ts
94
- class OssBase {
95
- client;
96
- bucketName;
97
- prefix = "";
98
- hash = hash;
99
- constructor(opts) {
100
- if (!opts.client) {
101
- throw new Error("client is required");
102
- }
103
- this.bucketName = opts.bucketName;
104
- this.client = opts.client;
105
- this.prefix = opts?.prefix ?? "";
106
- }
107
- setPrefix(prefix) {
108
- this.prefix = prefix;
109
- }
110
- async getObject(objectName) {
111
- const bucketName = this.bucketName;
112
- const obj = await this.client.getObject(bucketName, `${this.prefix}${objectName}`);
113
- return obj;
114
- }
115
- async getJson(objectName) {
116
- const obj = await this.getObject(objectName);
117
- return new Promise((resolve, reject) => {
118
- let data = "";
119
- obj.on("data", (chunk) => {
120
- data += chunk;
121
- });
122
- obj.on("end", () => {
123
- try {
124
- const jsonData = JSON.parse(data);
125
- resolve(jsonData);
126
- } catch (error) {
127
- reject(new Error("Failed to parse JSON"));
128
- }
129
- });
130
- obj.on("error", (err) => {
131
- reject(err);
132
- });
133
- });
134
- }
135
- async putObject(objectName, data, metaData = {}, opts) {
136
- let putData;
137
- let size = opts?.size;
138
- const isStream = opts?.isStream;
139
- if (!isStream) {
140
- if (typeof data === "string") {
141
- putData = data;
142
- size = putData.length;
143
- } else {
144
- putData = JSON.stringify(data);
145
- size = putData.length;
146
- }
147
- } else {
148
- putData = data;
149
- if (!size) {
150
- throw new Error("Stream upload requires size parameter to avoid multipart upload and get standard MD5 ETag");
151
- }
152
- }
153
- if (opts?.check) {
154
- const obj2 = await this.statObject(objectName, true);
155
- if (obj2) {
156
- const omitMeda = ["size", "content-type", "cache-control", "app-source"];
157
- const objMeta = JSON.parse(JSON.stringify(omit(obj2.metaData, omitMeda)));
158
- metaData = {
159
- ...objMeta,
160
- ...metaData
161
- };
162
- }
163
- }
164
- const bucketName = this.bucketName;
165
- const obj = await this.client.putObject(bucketName, `${this.prefix}${objectName}`, putData, size, metaData);
166
- return obj;
167
- }
168
- async deleteObject(objectName) {
169
- const bucketName = this.bucketName;
170
- const obj = await this.client.removeObject(bucketName, `${this.prefix}${objectName}`);
171
- return obj;
172
- }
173
- async listObjects(objectName, opts) {
174
- const bucketName = this.bucketName;
175
- const prefix = `${this.prefix}${objectName}`;
176
- const res = await new Promise((resolve, reject) => {
177
- let res2 = [];
178
- let hasError = false;
179
- this.client.listObjectsV2(bucketName, prefix, opts?.recursive ?? false, opts?.startAfter).on("data", (data) => {
180
- res2.push(data);
181
- }).on("error", (err) => {
182
- console.error("minio error", prefix, err);
183
- hasError = true;
184
- }).on("end", () => {
185
- if (hasError) {
186
- reject();
187
- return;
188
- } else {
189
- resolve(res2);
190
- }
191
- });
192
- });
193
- return res;
194
- }
195
- async fPutObject(objectName, filePath, metaData) {
196
- const bucketName = this.bucketName;
197
- const obj = await this.client.fPutObject(bucketName, `${this.prefix}${objectName}`, filePath, metaData);
198
- return obj;
199
- }
200
- async getObjectName(objectName) {
201
- return `${this.prefix}${objectName}`;
202
- }
203
- async statObject(objectName, checkFile = true) {
204
- const bucketName = this.bucketName;
205
- try {
206
- const obj = await this.client.statObject(bucketName, `${this.prefix}${objectName}`);
207
- return obj;
208
- } catch (e) {
209
- if (e.code === "NotFound") {
210
- return null;
211
- }
212
- throw e;
213
- }
214
- }
215
- async checkObjectHash(objectName, hash2, meta) {
216
- const obj = await this.statObject(`${this.prefix}${objectName}`, true);
217
- if (!obj) {
218
- return { success: false, metaData: null, obj: null, equalMeta: false };
219
- }
220
- let metaData = {};
221
- const omitMeda = ["content-type", "cache-control", "app-source"];
222
- const objMeta = omit(obj.metaData, omitMeda);
223
- metaData = {
224
- ...objMeta
225
- };
226
- let equalMeta = false;
227
- if (meta) {
228
- equalMeta = JSON.stringify(metaData) === JSON.stringify(meta);
229
- }
230
- return { success: obj.etag === hash2, metaData, obj, equalMeta };
231
- }
232
- getMetadata(pathname, meta = { "app-source": "user-app" }) {
233
- const isHtml = pathname.endsWith(".html");
234
- if (isHtml) {
235
- meta = {
236
- ...meta,
237
- "content-type": "text/html; charset=utf-8",
238
- "cache-control": "no-cache"
239
- };
240
- } else {
241
- meta = {
242
- ...meta,
243
- "content-type": getContentType(pathname),
244
- "cache-control": "max-age=31536000, immutable"
245
- };
246
- }
247
- return meta;
248
- }
249
- async copyObject(sourceObject, targetObject) {
250
- const bucketName = this.bucketName;
251
- const obj = await this.client.copyObject(bucketName, sourceObject, targetObject);
252
- return obj;
253
- }
254
- async replaceObject(objectName, meta) {
255
- const { bucketName, client } = this;
256
- return copyObject({ bucketName, client, objectName: `${this.prefix}${objectName}`, newMetadata: meta });
257
- }
258
- static create(opts) {
259
- return new this(opts);
260
- }
261
- static fromBase(createOpts) {
262
- const base = createOpts.oss;
263
- const opts = createOpts.opts;
264
- return new this({
265
- client: base.client,
266
- bucketName: base.bucketName,
267
- ...opts
268
- });
269
- }
270
- }
271
- // src/util/extract-standard-headers.ts
272
- var standardHeaderKeys = ["content-type", "cache-control", "content-disposition", "content-encoding", "content-language", "expires"];
273
- function extractStandardHeaders(metaData) {
274
- const standardHeaders = {};
275
- const customMetadata = {};
276
- for (const [key, value] of Object.entries(metaData)) {
277
- const lowerKey = key.toLowerCase();
278
- if (lowerKey === "content-type") {
279
- standardHeaders.ContentType = value;
280
- } else if (lowerKey === "cache-control") {
281
- standardHeaders.CacheControl = value;
282
- } else if (lowerKey === "content-disposition") {
283
- standardHeaders.ContentDisposition = value;
284
- } else if (lowerKey === "content-encoding") {
285
- standardHeaders.ContentEncoding = value;
286
- } else if (lowerKey === "content-language") {
287
- standardHeaders.ContentLanguage = value;
288
- } else if (lowerKey === "expires") {
289
- standardHeaders.Expires = new Date(value);
290
- } else {
291
- customMetadata[key] = value;
292
- }
293
- }
294
- return { standardHeaders, customMetadata };
295
- }
296
- // src/services/config.ts
297
- class ConfigOssService extends OssBase {
298
- owner;
299
- constructor(opts) {
300
- super(opts);
301
- this.owner = opts.owner;
302
- this.setPrefix(`${this.owner}/config/1.0.0/`);
303
- }
304
- async listAllFile() {
305
- const list = await this.listObjects("");
306
- return list.filter((item) => item.size > 0 && this.isEndWithJson(item.name));
307
- }
308
- async listAll() {
309
- return await this.listObjects("");
310
- }
311
- configMap = new Map;
312
- keys = [];
313
- async getAllConfigJson() {
314
- const list = await this.listAllFile();
315
- return list;
316
- }
317
- isEndWithJson(string) {
318
- return string?.endsWith?.(`.json`);
319
- }
320
- putJsonObject(key, data) {
321
- const json = hashSringify(data);
322
- return this.putObject(key, json, {
323
- "Content-Type": "application/json",
324
- "app-source": "user-config-app",
325
- "Cache-Control": "max-age=31536000, immutable"
326
- });
327
- }
328
- async getObjectList(objectNameList) {
329
- const jsonMap = new Map;
330
- for (const objectName of objectNameList) {
331
- try {
332
- const json = await this.getJson(objectName);
333
- jsonMap.set(objectName, json);
334
- } catch (error) {
335
- console.error(error);
336
- continue;
337
- }
338
- }
339
- return jsonMap;
340
- }
341
- async getList() {
342
- const list = await this.listAllFile();
343
- const keyEtagMap = new Map;
344
- const listKeys = list.map((item) => {
345
- const key = item.name.replace(this.prefix, "");
346
- keyEtagMap.set(key, item.etag);
347
- return {
348
- ...item,
349
- key
350
- };
351
- });
352
- const keys = Array.from(keyEtagMap.keys());
353
- return { list: listKeys, keys, keyEtagMap };
354
- }
355
- }
356
- export {
357
- ConfigOssService
358
- };