@devbro/neko-storage 0.1.1 → 0.1.3

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.
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './types';\nexport * from './Storage';\nexport * from './AWSS3Storage';\nexport * from './LocalStorage';\nexport * from './StorageFactory';\n"],"mappings":";;;;;;;;;;;;;;;AAAA;;0BAAc,oBAAd;AACA,0BAAc,sBADd;AAEA,0BAAc,2BAFd;AAGA,0BAAc,2BAHd;AAIA,0BAAc,6BAJd;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts","../src/Storage.mts","../src/AWSS3Storage.mts","../src/LocalStorage.mts","../src/StorageFactory.mts"],"sourcesContent":["export * from './types.mjs';\nexport * from './Storage.mjs';\nexport * from './AWSS3Storage.mjs';\nexport * from './LocalStorage.mjs';\nexport * from './StorageFactory.mjs';\n","import { ReadStream } from 'fs';\nimport { Stream } from 'stream';\nimport { Metadata } from './types.mjs';\nimport { StorageConfig } from './types.mjs';\n\nexport abstract class Storage {\n constructor(protected config: StorageConfig) {}\n\n static canHandle(config: StorageConfig): boolean {\n throw new Error('Method not implemented.');\n }\n\n abstract exists(path: string): Promise<boolean>;\n abstract put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;\n abstract getJson(path: string): Promise<object>;\n abstract getString(path: string): Promise<string>;\n abstract getBuffer(path: string): Promise<Buffer>;\n abstract getStream(path: string): Promise<ReadStream>;\n abstract delete(path: string): Promise<boolean>;\n abstract metadata(path: string): Promise<Metadata>;\n}\n","import { Metadata, StorageConfig } from './types.mjs';\nimport { Storage } from './Storage.mjs';\nimport {\n S3Client,\n HeadObjectCommand,\n PutObjectCommand,\n GetObjectCommand,\n DeleteObjectCommand,\n HeadObjectOutput,\n} from '@aws-sdk/client-s3';\nimport { ReadStream } from 'fs';\nimport Stream, { Readable } from 'stream';\n\nexport class AWSS3Storage extends Storage {\n private s3: S3Client;\n\n constructor(protected config: StorageConfig) {\n super(config);\n\n if (!AWSS3Storage.canHandle(config)) {\n throw new Error(`storage engine cannot handle this config.`);\n }\n\n this.s3 = new S3Client(this.config?.s3Config || {});\n }\n\n static canHandle(config: StorageConfig): boolean {\n return config.engine === 's3';\n }\n\n async exists(path: string): Promise<boolean> {\n try {\n await this.s3.send(new HeadObjectCommand({ Bucket: this.config?.bucket, Key: path }));\n return true;\n } catch (error: any) {\n if (error.name === 'NotFound') {\n return false;\n }\n throw error;\n }\n }\n\n async put(path: string, content: string | object | Stream | Buffer): Promise<boolean> {\n let body: any;\n if (typeof content === 'string' || content instanceof Buffer) {\n body = content;\n } else if (typeof content === 'object' && !(content instanceof Stream)) {\n body = JSON.stringify(content);\n } else if (content instanceof Stream) {\n body = content;\n } else {\n throw new Error('Unsupported content type');\n }\n\n await this.s3.send(\n new PutObjectCommand({\n Bucket: this.config.bucket,\n Key: path,\n Body: body,\n })\n );\n\n return true;\n }\n\n async getJson(path: string): Promise<object> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n const body = await this.streamToString(data.Body as Stream);\n return JSON.parse(body);\n }\n\n async getString(path: string): Promise<string> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return await this.streamToString(data.Body as Stream);\n }\n\n async delete(path: string): Promise<boolean> {\n await this.s3.send(new DeleteObjectCommand({ Bucket: this.config.bucket, Key: path }));\n return true;\n }\n\n private async streamToString(stream: Stream): Promise<string> {\n return new Promise((resolve, reject) => {\n const chunks: Uint8Array[] = [];\n stream.on('data', (chunk) => chunks.push(chunk));\n stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf-8')));\n stream.on('error', reject);\n });\n }\n\n async getBuffer(path: string): Promise<Buffer> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n const chunks: Uint8Array[] = [];\n const stream = data.Body as Readable;\n\n return new Promise((resolve, reject) => {\n stream.on('data', (chunk) => chunks.push(chunk));\n stream.on('end', () => resolve(Buffer.concat(chunks)));\n stream.on('error', reject);\n });\n }\n\n async getStream(path: string): Promise<ReadStream> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return data.Body as unknown as ReadStream;\n }\n\n async metadata(path: string): Promise<Metadata> {\n const metadata = await this.s3.send(\n new HeadObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return {\n size: metadata.ContentLength || 0,\n mimeType: metadata.ContentType || 'unknown',\n lastModifiedDate: (metadata.LastModified || new Date(0)).toISOString(),\n };\n }\n}\n","import Stream from 'stream';\nimport * as fs from 'fs/promises';\nimport { createWriteStream, createReadStream, ReadStream } from 'fs';\nimport * as path from 'path';\nimport * as mime from 'mime-types';\nimport { Metadata, StorageConfig } from './types.mjs';\nimport { Storage } from './Storage.mjs';\n\nexport class LocalStorage extends Storage {\n constructor(config: StorageConfig) {\n super(config);\n\n if (!LocalStorage.canHandle(config)) {\n throw new Error(`storage engine cannot handle this config.`);\n }\n // Ensure the base folder exists\n fs.mkdir(this.config.basePath, { recursive: true }).catch((error) => {\n throw error;\n });\n }\n\n async metadata(path: string): Promise<Metadata> {\n const fullPath = this.getFullPath(path);\n const stats = await fs.stat(fullPath);\n return {\n size: stats.size,\n mimeType: mime.lookup(fullPath) || 'unknown',\n lastModifiedDate: stats.mtime.toISOString(),\n };\n }\n\n static canHandle(config: StorageConfig) {\n if (config.engine === 'local') {\n return true;\n }\n return false;\n }\n\n getFullPath(filePath: string) {\n return path.join(this.config.basePath, filePath);\n }\n\n async exists(path: string): Promise<boolean> {\n try {\n await fs.access(this.getFullPath(path));\n return true;\n } catch {\n return false;\n }\n }\n\n async put(filepath: string, content: string | object | Stream | Buffer): Promise<boolean> {\n const fullPath = this.getFullPath(filepath);\n\n const dir = path.dirname(fullPath);\n await fs.mkdir(dir, { recursive: true });\n\n if (typeof content === 'string' || content instanceof Buffer) {\n await fs.writeFile(fullPath, content);\n } else if (typeof content === 'object' && !(content instanceof Stream)) {\n await fs.writeFile(fullPath, JSON.stringify(content, null, 2));\n } else if (typeof content === 'object' && content instanceof Stream) {\n const writeStream = createWriteStream(fullPath);\n await new Promise((resolve, reject) => {\n (content as Stream).pipe(writeStream);\n (content as Stream).on('end', resolve);\n (content as Stream).on('error', reject);\n });\n } else {\n throw new Error('Unsupported content type');\n }\n\n return true;\n }\n\n async getJson(path: string): Promise<object> {\n const fullPath = this.getFullPath(path);\n const content = await fs.readFile(fullPath, 'utf-8');\n return JSON.parse(content);\n }\n\n async getString(path: string, encoding: BufferEncoding = 'utf-8'): Promise<string> {\n const fullPath = this.getFullPath(path);\n return await fs.readFile(fullPath, encoding);\n }\n\n async getBuffer(path: string): Promise<Buffer> {\n const fullPath = this.getFullPath(path);\n return await fs.readFile(fullPath);\n }\n\n async getStream(path: string): Promise<ReadStream> {\n const fullPath = this.getFullPath(path);\n return createReadStream(fullPath);\n }\n\n async delete(path: string): Promise<boolean> {\n const fullPath = this.getFullPath(path);\n await fs.unlink(fullPath);\n return true;\n }\n}\n","import { AWSS3Storage } from './AWSS3Storage.mjs';\nimport { LocalStorage } from './LocalStorage.mjs';\nimport { Storage } from './Storage.mjs';\nimport { StorageConfig } from './types.mjs';\n\nexport class StorageFactory {\n public static storageEngines: (typeof Storage)[] = [LocalStorage, AWSS3Storage];\n\n registerStorageEngine(engine: typeof Storage) {\n StorageFactory.storageEngines.push(engine);\n }\n\n public static create(config: StorageConfig): Storage {\n for (const engine of StorageFactory.storageEngines) {\n if (engine.canHandle(config)) {\n // @ts-ignore\n return new engine(config);\n }\n }\n throw new Error('No matchin storage engine found');\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;ACKO,IAAe,WAAf,MAAe,SAAQ;AAAA,EAC5B,YAAsB,QAAuB;AAAvB;AAAA,EAAwB;AAAA,EAE9C,OAAO,UAAU,QAAgC;AAC/C,UAAM,IAAI,MAAM,yBAAyB;AAAA,EAC3C;AAUF;AAf8B;AAAvB,IAAe,UAAf;;;ACHP,uBAOO;AAEP,oBAAiC;AAE1B,IAAM,gBAAN,MAAM,sBAAqB,QAAQ;AAAA,EAGxC,YAAsB,QAAuB;AAhB/C;AAiBI,UAAM,MAAM;AADQ;AAGpB,QAAI,CAAC,cAAa,UAAU,MAAM,GAAG;AACnC,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAEA,SAAK,KAAK,IAAI,4BAAS,UAAK,WAAL,mBAAa,aAAY,CAAC,CAAC;AAAA,EACpD;AAAA,EAEA,OAAO,UAAU,QAAgC;AAC/C,WAAO,OAAO,WAAW;AAAA,EAC3B;AAAA,EAEM,OAAOA,OAAgC;AAAA;AA9B/C;AA+BI,UAAI;AACF,cAAM,KAAK,GAAG,KAAK,IAAI,mCAAkB,EAAE,SAAQ,UAAK,WAAL,mBAAa,QAAQ,KAAKA,MAAK,CAAC,CAAC;AACpF,eAAO;AAAA,MACT,SAAS,OAAY;AACnB,YAAI,MAAM,SAAS,YAAY;AAC7B,iBAAO;AAAA,QACT;AACA,cAAM;AAAA,MACR;AAAA,IACF;AAAA;AAAA,EAEM,IAAIA,OAAc,SAA8D;AAAA;AACpF,UAAI;AACJ,UAAI,OAAO,YAAY,YAAY,mBAAmB,QAAQ;AAC5D,eAAO;AAAA,MACT,WAAW,OAAO,YAAY,YAAY,EAAE,mBAAmB,cAAAC,UAAS;AACtE,eAAO,KAAK,UAAU,OAAO;AAAA,MAC/B,WAAW,mBAAmB,cAAAA,SAAQ;AACpC,eAAO;AAAA,MACT,OAAO;AACL,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AAEA,YAAM,KAAK,GAAG;AAAA,QACZ,IAAI,kCAAiB;AAAA,UACnB,QAAQ,KAAK,OAAO;AAAA,UACpB,KAAKD;AAAA,UACL,MAAM;AAAA,QACR,CAAC;AAAA,MACH;AAEA,aAAO;AAAA,IACT;AAAA;AAAA,EAEM,QAAQA,OAA+B;AAAA;AAC3C,YAAM,OAAO,MAAM,KAAK,GAAG;AAAA,QACzB,IAAI,kCAAiB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC;AAAA,MAChE;AACA,YAAM,OAAO,MAAM,KAAK,eAAe,KAAK,IAAc;AAC1D,aAAO,KAAK,MAAM,IAAI;AAAA,IACxB;AAAA;AAAA,EAEM,UAAUA,OAA+B;AAAA;AAC7C,YAAM,OAAO,MAAM,KAAK,GAAG;AAAA,QACzB,IAAI,kCAAiB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC;AAAA,MAChE;AACA,aAAO,MAAM,KAAK,eAAe,KAAK,IAAc;AAAA,IACtD;AAAA;AAAA,EAEM,OAAOA,OAAgC;AAAA;AAC3C,YAAM,KAAK,GAAG,KAAK,IAAI,qCAAoB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC,CAAC;AACrF,aAAO;AAAA,IACT;AAAA;AAAA,EAEc,eAAe,QAAiC;AAAA;AAC5D,aAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,cAAM,SAAuB,CAAC;AAC9B,eAAO,GAAG,QAAQ,CAAC,UAAU,OAAO,KAAK,KAAK,CAAC;AAC/C,eAAO,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,MAAM,EAAE,SAAS,OAAO,CAAC,CAAC;AACvE,eAAO,GAAG,SAAS,MAAM;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA;AAAA,EAEM,UAAUA,OAA+B;AAAA;AAC7C,YAAM,OAAO,MAAM,KAAK,GAAG;AAAA,QACzB,IAAI,kCAAiB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC;AAAA,MAChE;AACA,YAAM,SAAuB,CAAC;AAC9B,YAAM,SAAS,KAAK;AAEpB,aAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,eAAO,GAAG,QAAQ,CAAC,UAAU,OAAO,KAAK,KAAK,CAAC;AAC/C,eAAO,GAAG,OAAO,MAAM,QAAQ,OAAO,OAAO,MAAM,CAAC,CAAC;AACrD,eAAO,GAAG,SAAS,MAAM;AAAA,MAC3B,CAAC;AAAA,IACH;AAAA;AAAA,EAEM,UAAUA,OAAmC;AAAA;AACjD,YAAM,OAAO,MAAM,KAAK,GAAG;AAAA,QACzB,IAAI,kCAAiB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC;AAAA,MAChE;AACA,aAAO,KAAK;AAAA,IACd;AAAA;AAAA,EAEM,SAASA,OAAiC;AAAA;AAC9C,YAAM,WAAW,MAAM,KAAK,GAAG;AAAA,QAC7B,IAAI,mCAAkB,EAAE,QAAQ,KAAK,OAAO,QAAQ,KAAKA,MAAK,CAAC;AAAA,MACjE;AACA,aAAO;AAAA,QACL,MAAM,SAAS,iBAAiB;AAAA,QAChC,UAAU,SAAS,eAAe;AAAA,QAClC,mBAAmB,SAAS,gBAAgB,oBAAI,KAAK,CAAC,GAAG,YAAY;AAAA,MACvE;AAAA,IACF;AAAA;AACF;AAhH0C;AAAnC,IAAM,eAAN;;;ACbP,IAAAE,iBAAmB;AACnB,SAAoB;AACpB,gBAAgE;AAChE,WAAsB;AACtB,WAAsB;AAIf,IAAM,gBAAN,MAAM,sBAAqB,QAAQ;AAAA,EACxC,YAAY,QAAuB;AACjC,UAAM,MAAM;AAEZ,QAAI,CAAC,cAAa,UAAU,MAAM,GAAG;AACnC,YAAM,IAAI,MAAM,2CAA2C;AAAA,IAC7D;AAEA,IAAG,SAAM,KAAK,OAAO,UAAU,EAAE,WAAW,KAAK,CAAC,EAAE,MAAM,CAAC,UAAU;AACnE,YAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA,EAEM,SAASC,OAAiC;AAAA;AAC9C,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,YAAM,QAAQ,MAAS,QAAK,QAAQ;AACpC,aAAO;AAAA,QACL,MAAM,MAAM;AAAA,QACZ,UAAe,YAAO,QAAQ,KAAK;AAAA,QACnC,kBAAkB,MAAM,MAAM,YAAY;AAAA,MAC5C;AAAA,IACF;AAAA;AAAA,EAEA,OAAO,UAAU,QAAuB;AACtC,QAAI,OAAO,WAAW,SAAS;AAC7B,aAAO;AAAA,IACT;AACA,WAAO;AAAA,EACT;AAAA,EAEA,YAAY,UAAkB;AAC5B,WAAY,UAAK,KAAK,OAAO,UAAU,QAAQ;AAAA,EACjD;AAAA,EAEM,OAAOA,OAAgC;AAAA;AAC3C,UAAI;AACF,cAAS,UAAO,KAAK,YAAYA,KAAI,CAAC;AACtC,eAAO;AAAA,MACT,SAAQ;AACN,eAAO;AAAA,MACT;AAAA,IACF;AAAA;AAAA,EAEM,IAAI,UAAkB,SAA8D;AAAA;AACxF,YAAM,WAAW,KAAK,YAAY,QAAQ;AAE1C,YAAM,MAAW,aAAQ,QAAQ;AACjC,YAAS,SAAM,KAAK,EAAE,WAAW,KAAK,CAAC;AAEvC,UAAI,OAAO,YAAY,YAAY,mBAAmB,QAAQ;AAC5D,cAAS,aAAU,UAAU,OAAO;AAAA,MACtC,WAAW,OAAO,YAAY,YAAY,EAAE,mBAAmB,eAAAC,UAAS;AACtE,cAAS,aAAU,UAAU,KAAK,UAAU,SAAS,MAAM,CAAC,CAAC;AAAA,MAC/D,WAAW,OAAO,YAAY,YAAY,mBAAmB,eAAAA,SAAQ;AACnE,cAAM,kBAAc,6BAAkB,QAAQ;AAC9C,cAAM,IAAI,QAAQ,CAAC,SAAS,WAAW;AACrC,UAAC,QAAmB,KAAK,WAAW;AACpC,UAAC,QAAmB,GAAG,OAAO,OAAO;AACrC,UAAC,QAAmB,GAAG,SAAS,MAAM;AAAA,QACxC,CAAC;AAAA,MACH,OAAO;AACL,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AAEA,aAAO;AAAA,IACT;AAAA;AAAA,EAEM,QAAQD,OAA+B;AAAA;AAC3C,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,YAAM,UAAU,MAAS,YAAS,UAAU,OAAO;AACnD,aAAO,KAAK,MAAM,OAAO;AAAA,IAC3B;AAAA;AAAA,EAEM,UAAUA,OAAc,WAA2B,SAA0B;AAAA;AACjF,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,aAAO,MAAS,YAAS,UAAU,QAAQ;AAAA,IAC7C;AAAA;AAAA,EAEM,UAAUA,OAA+B;AAAA;AAC7C,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,aAAO,MAAS,YAAS,QAAQ;AAAA,IACnC;AAAA;AAAA,EAEM,UAAUA,OAAmC;AAAA;AACjD,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,iBAAO,4BAAiB,QAAQ;AAAA,IAClC;AAAA;AAAA,EAEM,OAAOA,OAAgC;AAAA;AAC3C,YAAM,WAAW,KAAK,YAAYA,KAAI;AACtC,YAAS,UAAO,QAAQ;AACxB,aAAO;AAAA,IACT;AAAA;AACF;AA7F0C;AAAnC,IAAM,eAAN;;;ACHA,IAAM,kBAAN,MAAM,gBAAe;AAAA,EAG1B,sBAAsB,QAAwB;AAC5C,oBAAe,eAAe,KAAK,MAAM;AAAA,EAC3C;AAAA,EAEA,OAAc,OAAO,QAAgC;AACnD,eAAW,UAAU,gBAAe,gBAAgB;AAClD,UAAI,OAAO,UAAU,MAAM,GAAG;AAE5B,eAAO,IAAI,OAAO,MAAM;AAAA,MAC1B;AAAA,IACF;AACA,UAAM,IAAI,MAAM,iCAAiC;AAAA,EACnD;AACF;AAhB4B;AAAf,gBACG,iBAAqC,CAAC,cAAc,YAAY;AADzE,IAAM,iBAAN;","names":["path","Stream","import_stream","path","Stream"]}
package/dist/index.mjs CHANGED
@@ -1,6 +1,6 @@
1
- export * from "./types";
2
- export * from "./Storage";
3
- export * from "./AWSS3Storage";
4
- export * from "./LocalStorage";
5
- export * from "./StorageFactory";
1
+ export * from "./types.mjs";
2
+ export * from "./Storage.mjs";
3
+ export * from "./AWSS3Storage.mjs";
4
+ export * from "./LocalStorage.mjs";
5
+ export * from "./StorageFactory.mjs";
6
6
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './types';\nexport * from './Storage';\nexport * from './AWSS3Storage';\nexport * from './LocalStorage';\nexport * from './StorageFactory';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
1
+ {"version":3,"sources":["../src/index.ts"],"sourcesContent":["export * from './types.mjs';\nexport * from './Storage.mjs';\nexport * from './AWSS3Storage.mjs';\nexport * from './LocalStorage.mjs';\nexport * from './StorageFactory.mjs';\n"],"mappings":"AAAA,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;AACd,cAAc;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devbro/neko-storage",
3
- "version": "0.1.1",
3
+ "version": "0.1.3",
4
4
  "description": "abstracted file storage implementation",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
@@ -17,7 +17,9 @@
17
17
  },
18
18
  "scripts": {
19
19
  "build": "tsup",
20
- "test": "jest",
20
+ "test": "vitest run",
21
+ "test:watch": "vitest watch",
22
+ "test:coverage": "vitest run --coverage",
21
23
  "format": "eslint . --fix --ext ts,tsx --report-unused-disable-directives --max-warnings 0 ",
22
24
  "prepare": "husky",
23
25
  "prettier": "prettier --write .",
@@ -1,23 +0,0 @@
1
- import { StorageConfig, Metadata } from './types.js';
2
- import { Storage } from './Storage.js';
3
- import { ReadStream } from 'fs';
4
- import Stream from 'stream';
5
- import '@aws-sdk/client-s3';
6
-
7
- declare class AWSS3Storage extends Storage {
8
- protected config: StorageConfig;
9
- private s3;
10
- constructor(config: StorageConfig);
11
- static canHandle(config: StorageConfig): boolean;
12
- exists(path: string): Promise<boolean>;
13
- put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
14
- getJson(path: string): Promise<object>;
15
- getString(path: string): Promise<string>;
16
- delete(path: string): Promise<boolean>;
17
- private streamToString;
18
- getBuffer(path: string): Promise<Buffer>;
19
- getStream(path: string): Promise<ReadStream>;
20
- metadata(path: string): Promise<Metadata>;
21
- }
22
-
23
- export { AWSS3Storage };
@@ -1,194 +0,0 @@
1
- "use strict";
2
- var __create = Object.create;
3
- var __defProp = Object.defineProperty;
4
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
- var __getOwnPropNames = Object.getOwnPropertyNames;
6
- var __getProtoOf = Object.getPrototypeOf;
7
- var __hasOwnProp = Object.prototype.hasOwnProperty;
8
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
9
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
10
- var __export = (target, all) => {
11
- for (var name in all)
12
- __defProp(target, name, { get: all[name], enumerable: true });
13
- };
14
- var __copyProps = (to, from, except, desc) => {
15
- if (from && typeof from === "object" || typeof from === "function") {
16
- for (let key of __getOwnPropNames(from))
17
- if (!__hasOwnProp.call(to, key) && key !== except)
18
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
19
- }
20
- return to;
21
- };
22
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
23
- // If the importer is in node compatibility mode or this is not an ESM
24
- // file that has been converted to a CommonJS file using a Babel-
25
- // compatible transform (i.e. "__esModule" has not been set), then set
26
- // "default" to the CommonJS "module.exports" for node compatibility.
27
- isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
28
- mod
29
- ));
30
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
31
- var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
32
- var __async = (__this, __arguments, generator) => {
33
- return new Promise((resolve, reject) => {
34
- var fulfilled = (value) => {
35
- try {
36
- step(generator.next(value));
37
- } catch (e) {
38
- reject(e);
39
- }
40
- };
41
- var rejected = (value) => {
42
- try {
43
- step(generator.throw(value));
44
- } catch (e) {
45
- reject(e);
46
- }
47
- };
48
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
49
- step((generator = generator.apply(__this, __arguments)).next());
50
- });
51
- };
52
- var AWSS3Storage_exports = {};
53
- __export(AWSS3Storage_exports, {
54
- AWSS3Storage: () => AWSS3Storage
55
- });
56
- module.exports = __toCommonJS(AWSS3Storage_exports);
57
- var import_Storage = require("./Storage");
58
- var import_client_s3 = require("@aws-sdk/client-s3");
59
- var import_stream = __toESM(require("stream"));
60
- const _AWSS3Storage = class _AWSS3Storage extends import_Storage.Storage {
61
- constructor(config) {
62
- var _a;
63
- super(config);
64
- __publicField(this, "config");
65
- __publicField(this, "s3");
66
- this.config = config;
67
- if (!_AWSS3Storage.canHandle(config)) {
68
- throw new Error(`storage engine cannot handle this config.`);
69
- }
70
- this.s3 = new import_client_s3.S3Client(((_a = this.config) == null ? void 0 : _a.s3Config) || {});
71
- }
72
- static canHandle(config) {
73
- return config.engine === "s3";
74
- }
75
- exists(path) {
76
- return __async(this, null, function* () {
77
- var _a;
78
- try {
79
- yield this.s3.send(new import_client_s3.HeadObjectCommand({
80
- Bucket: (_a = this.config) == null ? void 0 : _a.bucket,
81
- Key: path
82
- }));
83
- return true;
84
- } catch (error) {
85
- if (error.name === "NotFound") {
86
- return false;
87
- }
88
- throw error;
89
- }
90
- });
91
- }
92
- put(path, content) {
93
- return __async(this, null, function* () {
94
- let body;
95
- if (typeof content === "string" || content instanceof Buffer) {
96
- body = content;
97
- } else if (typeof content === "object" && !(content instanceof import_stream.default)) {
98
- body = JSON.stringify(content);
99
- } else if (content instanceof import_stream.default) {
100
- body = content;
101
- } else {
102
- throw new Error("Unsupported content type");
103
- }
104
- yield this.s3.send(new import_client_s3.PutObjectCommand({
105
- Bucket: this.config.bucket,
106
- Key: path,
107
- Body: body
108
- }));
109
- return true;
110
- });
111
- }
112
- getJson(path) {
113
- return __async(this, null, function* () {
114
- const data = yield this.s3.send(new import_client_s3.GetObjectCommand({
115
- Bucket: this.config.bucket,
116
- Key: path
117
- }));
118
- const body = yield this.streamToString(data.Body);
119
- return JSON.parse(body);
120
- });
121
- }
122
- getString(path) {
123
- return __async(this, null, function* () {
124
- const data = yield this.s3.send(new import_client_s3.GetObjectCommand({
125
- Bucket: this.config.bucket,
126
- Key: path
127
- }));
128
- return yield this.streamToString(data.Body);
129
- });
130
- }
131
- delete(path) {
132
- return __async(this, null, function* () {
133
- yield this.s3.send(new import_client_s3.DeleteObjectCommand({
134
- Bucket: this.config.bucket,
135
- Key: path
136
- }));
137
- return true;
138
- });
139
- }
140
- streamToString(stream) {
141
- return __async(this, null, function* () {
142
- return new Promise((resolve, reject) => {
143
- const chunks = [];
144
- stream.on("data", (chunk) => chunks.push(chunk));
145
- stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf-8")));
146
- stream.on("error", reject);
147
- });
148
- });
149
- }
150
- getBuffer(path) {
151
- return __async(this, null, function* () {
152
- const data = yield this.s3.send(new import_client_s3.GetObjectCommand({
153
- Bucket: this.config.bucket,
154
- Key: path
155
- }));
156
- const chunks = [];
157
- const stream = data.Body;
158
- return new Promise((resolve, reject) => {
159
- stream.on("data", (chunk) => chunks.push(chunk));
160
- stream.on("end", () => resolve(Buffer.concat(chunks)));
161
- stream.on("error", reject);
162
- });
163
- });
164
- }
165
- getStream(path) {
166
- return __async(this, null, function* () {
167
- const data = yield this.s3.send(new import_client_s3.GetObjectCommand({
168
- Bucket: this.config.bucket,
169
- Key: path
170
- }));
171
- return data.Body;
172
- });
173
- }
174
- metadata(path) {
175
- return __async(this, null, function* () {
176
- const metadata = yield this.s3.send(new import_client_s3.HeadObjectCommand({
177
- Bucket: this.config.bucket,
178
- Key: path
179
- }));
180
- return {
181
- size: metadata.ContentLength || 0,
182
- mimeType: metadata.ContentType || "unknown",
183
- lastModifiedDate: (metadata.LastModified || /* @__PURE__ */ new Date(0)).toISOString()
184
- };
185
- });
186
- }
187
- };
188
- __name(_AWSS3Storage, "AWSS3Storage");
189
- let AWSS3Storage = _AWSS3Storage;
190
- // Annotate the CommonJS export names for ESM import in node:
191
- 0 && (module.exports = {
192
- AWSS3Storage
193
- });
194
- //# sourceMappingURL=AWSS3Storage.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/AWSS3Storage.ts"],"sourcesContent":["import { Metadata, StorageConfig } from './types';\nimport { Storage } from './Storage';\nimport {\n S3Client,\n HeadObjectCommand,\n PutObjectCommand,\n GetObjectCommand,\n DeleteObjectCommand,\n HeadObjectOutput,\n} from '@aws-sdk/client-s3';\nimport { ReadStream } from 'fs';\nimport Stream, { Readable } from 'stream';\n\nexport class AWSS3Storage extends Storage {\n private s3: S3Client;\n\n constructor(protected config: StorageConfig) {\n super(config);\n\n if (!AWSS3Storage.canHandle(config)) {\n throw new Error(`storage engine cannot handle this config.`);\n }\n\n this.s3 = new S3Client(this.config?.s3Config || {});\n }\n\n static canHandle(config: StorageConfig): boolean {\n return config.engine === 's3';\n }\n\n async exists(path: string): Promise<boolean> {\n try {\n await this.s3.send(new HeadObjectCommand({ Bucket: this.config?.bucket, Key: path }));\n return true;\n } catch (error: any) {\n if (error.name === 'NotFound') {\n return false;\n }\n throw error;\n }\n }\n\n async put(path: string, content: string | object | Stream | Buffer): Promise<boolean> {\n let body: any;\n if (typeof content === 'string' || content instanceof Buffer) {\n body = content;\n } else if (typeof content === 'object' && !(content instanceof Stream)) {\n body = JSON.stringify(content);\n } else if (content instanceof Stream) {\n body = content;\n } else {\n throw new Error('Unsupported content type');\n }\n\n await this.s3.send(\n new PutObjectCommand({\n Bucket: this.config.bucket,\n Key: path,\n Body: body,\n })\n );\n\n return true;\n }\n\n async getJson(path: string): Promise<object> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n const body = await this.streamToString(data.Body as Stream);\n return JSON.parse(body);\n }\n\n async getString(path: string): Promise<string> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return await this.streamToString(data.Body as Stream);\n }\n\n async delete(path: string): Promise<boolean> {\n await this.s3.send(new DeleteObjectCommand({ Bucket: this.config.bucket, Key: path }));\n return true;\n }\n\n private async streamToString(stream: Stream): Promise<string> {\n return new Promise((resolve, reject) => {\n const chunks: Uint8Array[] = [];\n stream.on('data', (chunk) => chunks.push(chunk));\n stream.on('end', () => resolve(Buffer.concat(chunks).toString('utf-8')));\n stream.on('error', reject);\n });\n }\n\n async getBuffer(path: string): Promise<Buffer> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n const chunks: Uint8Array[] = [];\n const stream = data.Body as Readable;\n\n return new Promise((resolve, reject) => {\n stream.on('data', (chunk) => chunks.push(chunk));\n stream.on('end', () => resolve(Buffer.concat(chunks)));\n stream.on('error', reject);\n });\n }\n\n async getStream(path: string): Promise<ReadStream> {\n const data = await this.s3.send(\n new GetObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return data.Body as unknown as ReadStream;\n }\n\n async metadata(path: string): Promise<Metadata> {\n const metadata = await this.s3.send(\n new HeadObjectCommand({ Bucket: this.config.bucket, Key: path })\n );\n return {\n size: metadata.ContentLength || 0,\n mimeType: metadata.ContentType || 'unknown',\n lastModifiedDate: (metadata.LastModified || new Date(0)).toISOString(),\n };\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA;;;;;AAAA,qBAAwB;AACxB,uBAOO;AAEP,oBAAiC;AAE1B,MAAMA,gBAAN,MAAMA,sBAAqBC,uBAAAA;EAGhC,YAAsBC,QAAuB;AAf/C;AAgBI,UAAMA,MAAAA;;AAHAC;AAGAD,SADcA,SAAAA;AAGpB,QAAI,CAACF,cAAaI,UAAUF,MAAAA,GAAS;AACnC,YAAM,IAAIG,MAAM,2CAA2C;IAC7D;AAEA,SAAKF,KAAK,IAAIG,4BAAS,UAAKJ,WAAL,mBAAaK,aAAY,CAAC,CAAA;EACnD;EAEA,OAAOH,UAAUF,QAAgC;AAC/C,WAAOA,OAAOM,WAAW;EAC3B;EAEMC,OAAOC,MAAgC;;AA7B/C;AA8BI,UAAI;AACF,cAAM,KAAKP,GAAGQ,KAAK,IAAIC,mCAAkB;UAAEC,SAAQ,UAAKX,WAAL,mBAAaY;UAAQC,KAAKL;QAAK,CAAA,CAAA;AAClF,eAAO;MACT,SAASM,OAAY;AACnB,YAAIA,MAAMC,SAAS,YAAY;AAC7B,iBAAO;QACT;AACA,cAAMD;MACR;IACF;;EAEME,IAAIR,MAAcS,SAA8D;;AACpF,UAAIC;AACJ,UAAI,OAAOD,YAAY,YAAYA,mBAAmBE,QAAQ;AAC5DD,eAAOD;MACT,WAAW,OAAOA,YAAY,YAAY,EAAEA,mBAAmBG,cAAAA,UAAS;AACtEF,eAAOG,KAAKC,UAAUL,OAAAA;MACxB,WAAWA,mBAAmBG,cAAAA,SAAQ;AACpCF,eAAOD;MACT,OAAO;AACL,cAAM,IAAId,MAAM,0BAAA;MAClB;AAEA,YAAM,KAAKF,GAAGQ,KACZ,IAAIc,kCAAiB;QACnBZ,QAAQ,KAAKX,OAAOY;QACpBC,KAAKL;QACLgB,MAAMN;MACR,CAAA,CAAA;AAGF,aAAO;IACT;;EAEMO,QAAQjB,MAA+B;;AAC3C,YAAMkB,OAAO,MAAM,KAAKzB,GAAGQ,KACzB,IAAIkB,kCAAiB;QAAEhB,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AAE/D,YAAMU,OAAO,MAAM,KAAKU,eAAeF,KAAKF,IAAI;AAChD,aAAOH,KAAKQ,MAAMX,IAAAA;IACpB;;EAEMY,UAAUtB,MAA+B;;AAC7C,YAAMkB,OAAO,MAAM,KAAKzB,GAAGQ,KACzB,IAAIkB,kCAAiB;QAAEhB,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AAE/D,aAAO,MAAM,KAAKoB,eAAeF,KAAKF,IAAI;IAC5C;;EAEMO,OAAOvB,MAAgC;;AAC3C,YAAM,KAAKP,GAAGQ,KAAK,IAAIuB,qCAAoB;QAAErB,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AACnF,aAAO;IACT;;EAEcoB,eAAeK,QAAiC;;AAC5D,aAAO,IAAIC,QAAQ,CAACC,SAASC,WAAAA;AAC3B,cAAMC,SAAuB,CAAA;AAC7BJ,eAAOK,GAAG,QAAQ,CAACC,UAAUF,OAAOG,KAAKD,KAAAA,CAAAA;AACzCN,eAAOK,GAAG,OAAO,MAAMH,QAAQhB,OAAOsB,OAAOJ,MAAAA,EAAQK,SAAS,OAAA,CAAA,CAAA;AAC9DT,eAAOK,GAAG,SAASF,MAAAA;MACrB,CAAA;IACF;;EAEMO,UAAUnC,MAA+B;;AAC7C,YAAMkB,OAAO,MAAM,KAAKzB,GAAGQ,KACzB,IAAIkB,kCAAiB;QAAEhB,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AAE/D,YAAM6B,SAAuB,CAAA;AAC7B,YAAMJ,SAASP,KAAKF;AAEpB,aAAO,IAAIU,QAAQ,CAACC,SAASC,WAAAA;AAC3BH,eAAOK,GAAG,QAAQ,CAACC,UAAUF,OAAOG,KAAKD,KAAAA,CAAAA;AACzCN,eAAOK,GAAG,OAAO,MAAMH,QAAQhB,OAAOsB,OAAOJ,MAAAA,CAAAA,CAAAA;AAC7CJ,eAAOK,GAAG,SAASF,MAAAA;MACrB,CAAA;IACF;;EAEMQ,UAAUpC,MAAmC;;AACjD,YAAMkB,OAAO,MAAM,KAAKzB,GAAGQ,KACzB,IAAIkB,kCAAiB;QAAEhB,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AAE/D,aAAOkB,KAAKF;IACd;;EAEMqB,SAASrC,MAAiC;;AAC9C,YAAMqC,WAAW,MAAM,KAAK5C,GAAGQ,KAC7B,IAAIC,mCAAkB;QAAEC,QAAQ,KAAKX,OAAOY;QAAQC,KAAKL;MAAK,CAAA,CAAA;AAEhE,aAAO;QACLsC,MAAMD,SAASE,iBAAiB;QAChCC,UAAUH,SAASI,eAAe;QAClCC,mBAAmBL,SAASM,gBAAgB,oBAAIC,KAAK,CAAA,GAAIC,YAAW;MACtE;IACF;;AACF;AAhHkCtD;AAA3B,IAAMD,eAAN;","names":["AWSS3Storage","Storage","config","s3","canHandle","Error","S3Client","s3Config","engine","exists","path","send","HeadObjectCommand","Bucket","bucket","Key","error","name","put","content","body","Buffer","Stream","JSON","stringify","PutObjectCommand","Body","getJson","data","GetObjectCommand","streamToString","parse","getString","delete","DeleteObjectCommand","stream","Promise","resolve","reject","chunks","on","chunk","push","concat","toString","getBuffer","getStream","metadata","size","ContentLength","mimeType","ContentType","lastModifiedDate","LastModified","Date","toISOString"]}
@@ -1,21 +0,0 @@
1
- import Stream from 'stream';
2
- import { ReadStream } from 'fs';
3
- import { StorageConfig, Metadata } from './types.js';
4
- import { Storage } from './Storage.js';
5
- import '@aws-sdk/client-s3';
6
-
7
- declare class LocalStorage extends Storage {
8
- constructor(config: StorageConfig);
9
- metadata(path: string): Promise<Metadata>;
10
- static canHandle(config: StorageConfig): boolean;
11
- getFullPath(filePath: string): string;
12
- exists(path: string): Promise<boolean>;
13
- put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
14
- getJson(path: string): Promise<object>;
15
- getString(path: string, encoding?: BufferEncoding): Promise<string>;
16
- getBuffer(path: string): Promise<Buffer>;
17
- getStream(path: string): Promise<ReadStream>;
18
- delete(path: string): Promise<boolean>;
19
- }
20
-
21
- export { LocalStorage };
@@ -1,162 +0,0 @@
1
- "use strict";
2
- var __create = Object.create;
3
- var __defProp = Object.defineProperty;
4
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
- var __getOwnPropNames = Object.getOwnPropertyNames;
6
- var __getProtoOf = Object.getPrototypeOf;
7
- var __hasOwnProp = Object.prototype.hasOwnProperty;
8
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
9
- var __export = (target, all) => {
10
- for (var name in all)
11
- __defProp(target, name, { get: all[name], enumerable: true });
12
- };
13
- var __copyProps = (to, from, except, desc) => {
14
- if (from && typeof from === "object" || typeof from === "function") {
15
- for (let key of __getOwnPropNames(from))
16
- if (!__hasOwnProp.call(to, key) && key !== except)
17
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
18
- }
19
- return to;
20
- };
21
- var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
22
- // If the importer is in node compatibility mode or this is not an ESM
23
- // file that has been converted to a CommonJS file using a Babel-
24
- // compatible transform (i.e. "__esModule" has not been set), then set
25
- // "default" to the CommonJS "module.exports" for node compatibility.
26
- isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
27
- mod
28
- ));
29
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
30
- var __async = (__this, __arguments, generator) => {
31
- return new Promise((resolve, reject) => {
32
- var fulfilled = (value) => {
33
- try {
34
- step(generator.next(value));
35
- } catch (e) {
36
- reject(e);
37
- }
38
- };
39
- var rejected = (value) => {
40
- try {
41
- step(generator.throw(value));
42
- } catch (e) {
43
- reject(e);
44
- }
45
- };
46
- var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
47
- step((generator = generator.apply(__this, __arguments)).next());
48
- });
49
- };
50
- var LocalStorage_exports = {};
51
- __export(LocalStorage_exports, {
52
- LocalStorage: () => LocalStorage
53
- });
54
- module.exports = __toCommonJS(LocalStorage_exports);
55
- var import_stream = __toESM(require("stream"));
56
- var fs = __toESM(require("fs/promises"));
57
- var import_fs = require("fs");
58
- var path = __toESM(require("path"));
59
- var mime = __toESM(require("mime-types"));
60
- var import_Storage = require("./Storage");
61
- const _LocalStorage = class _LocalStorage extends import_Storage.Storage {
62
- constructor(config) {
63
- super(config);
64
- if (!_LocalStorage.canHandle(config)) {
65
- throw new Error(`storage engine cannot handle this config.`);
66
- }
67
- fs.mkdir(this.config.basePath, {
68
- recursive: true
69
- }).catch((error) => {
70
- throw error;
71
- });
72
- }
73
- metadata(path2) {
74
- return __async(this, null, function* () {
75
- const fullPath = this.getFullPath(path2);
76
- const stats = yield fs.stat(fullPath);
77
- return {
78
- size: stats.size,
79
- mimeType: mime.lookup(fullPath) || "unknown",
80
- lastModifiedDate: stats.mtime.toISOString()
81
- };
82
- });
83
- }
84
- static canHandle(config) {
85
- if (config.engine === "local") {
86
- return true;
87
- }
88
- return false;
89
- }
90
- getFullPath(filePath) {
91
- return path.join(this.config.basePath, filePath);
92
- }
93
- exists(path2) {
94
- return __async(this, null, function* () {
95
- try {
96
- yield fs.access(this.getFullPath(path2));
97
- return true;
98
- } catch (e) {
99
- return false;
100
- }
101
- });
102
- }
103
- put(path2, content) {
104
- return __async(this, null, function* () {
105
- const fullPath = this.getFullPath(path2);
106
- if (typeof content === "string" || content instanceof Buffer) {
107
- yield fs.writeFile(fullPath, content);
108
- } else if (typeof content === "object" && !(content instanceof import_stream.default)) {
109
- yield fs.writeFile(fullPath, JSON.stringify(content, null, 2));
110
- } else if (typeof content === "object" && content instanceof import_stream.default) {
111
- const writeStream = (0, import_fs.createWriteStream)(fullPath);
112
- yield new Promise((resolve, reject) => {
113
- content.pipe(writeStream);
114
- content.on("end", resolve);
115
- content.on("error", reject);
116
- });
117
- } else {
118
- throw new Error("Unsupported content type");
119
- }
120
- return true;
121
- });
122
- }
123
- getJson(path2) {
124
- return __async(this, null, function* () {
125
- const fullPath = this.getFullPath(path2);
126
- const content = yield fs.readFile(fullPath, "utf-8");
127
- return JSON.parse(content);
128
- });
129
- }
130
- getString(path2, encoding = "utf-8") {
131
- return __async(this, null, function* () {
132
- const fullPath = this.getFullPath(path2);
133
- return yield fs.readFile(fullPath, encoding);
134
- });
135
- }
136
- getBuffer(path2) {
137
- return __async(this, null, function* () {
138
- const fullPath = this.getFullPath(path2);
139
- return yield fs.readFile(fullPath);
140
- });
141
- }
142
- getStream(path2) {
143
- return __async(this, null, function* () {
144
- const fullPath = this.getFullPath(path2);
145
- return (0, import_fs.createReadStream)(fullPath);
146
- });
147
- }
148
- delete(path2) {
149
- return __async(this, null, function* () {
150
- const fullPath = this.getFullPath(path2);
151
- yield fs.unlink(fullPath);
152
- return true;
153
- });
154
- }
155
- };
156
- __name(_LocalStorage, "LocalStorage");
157
- let LocalStorage = _LocalStorage;
158
- // Annotate the CommonJS export names for ESM import in node:
159
- 0 && (module.exports = {
160
- LocalStorage
161
- });
162
- //# sourceMappingURL=LocalStorage.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/LocalStorage.ts"],"sourcesContent":["import Stream from 'stream';\nimport * as fs from 'fs/promises';\nimport { createWriteStream, createReadStream, ReadStream } from 'fs';\nimport * as path from 'path';\nimport * as mime from 'mime-types';\nimport { Metadata, StorageConfig } from './types';\nimport { Storage } from './Storage';\n\nexport class LocalStorage extends Storage {\n constructor(config: StorageConfig) {\n super(config);\n\n if (!LocalStorage.canHandle(config)) {\n throw new Error(`storage engine cannot handle this config.`);\n }\n // Ensure the base folder exists\n fs.mkdir(this.config.basePath, { recursive: true }).catch((error) => {\n throw error;\n });\n }\n\n async metadata(path: string): Promise<Metadata> {\n const fullPath = this.getFullPath(path);\n const stats = await fs.stat(fullPath);\n return {\n size: stats.size,\n mimeType: mime.lookup(fullPath) || 'unknown',\n lastModifiedDate: stats.mtime.toISOString(),\n };\n }\n\n static canHandle(config: StorageConfig) {\n if (config.engine === 'local') {\n return true;\n }\n return false;\n }\n\n getFullPath(filePath: string) {\n return path.join(this.config.basePath, filePath);\n }\n\n async exists(path: string): Promise<boolean> {\n try {\n await fs.access(this.getFullPath(path));\n return true;\n } catch {\n return false;\n }\n }\n\n async put(path: string, content: string | object | Stream | Buffer): Promise<boolean> {\n const fullPath = this.getFullPath(path);\n\n if (typeof content === 'string' || content instanceof Buffer) {\n await fs.writeFile(fullPath, content);\n } else if (typeof content === 'object' && !(content instanceof Stream)) {\n await fs.writeFile(fullPath, JSON.stringify(content, null, 2));\n } else if (typeof content === 'object' && content instanceof Stream) {\n const writeStream = createWriteStream(fullPath);\n await new Promise((resolve, reject) => {\n (content as Stream).pipe(writeStream);\n (content as Stream).on('end', resolve);\n (content as Stream).on('error', reject);\n });\n } else {\n throw new Error('Unsupported content type');\n }\n\n return true;\n }\n\n async getJson(path: string): Promise<object> {\n const fullPath = this.getFullPath(path);\n const content = await fs.readFile(fullPath, 'utf-8');\n return JSON.parse(content);\n }\n\n async getString(path: string, encoding: BufferEncoding = 'utf-8'): Promise<string> {\n const fullPath = this.getFullPath(path);\n return await fs.readFile(fullPath, encoding);\n }\n\n async getBuffer(path: string): Promise<Buffer> {\n const fullPath = this.getFullPath(path);\n return await fs.readFile(fullPath);\n }\n\n async getStream(path: string): Promise<ReadStream> {\n const fullPath = this.getFullPath(path);\n return createReadStream(fullPath);\n }\n\n async delete(path: string): Promise<boolean> {\n const fullPath = this.getFullPath(path);\n await fs.unlink(fullPath);\n return true;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;AAAA,oBAAmB;AACnB,SAAoB;AACpB,gBAAgE;AAChE,WAAsB;AACtB,WAAsB;AAEtB,qBAAwB;AAEjB,MAAMA,gBAAN,MAAMA,sBAAqBC,uBAAAA;EAChC,YAAYC,QAAuB;AACjC,UAAMA,MAAAA;AAEN,QAAI,CAACF,cAAaG,UAAUD,MAAAA,GAAS;AACnC,YAAM,IAAIE,MAAM,2CAA2C;IAC7D;AAEAC,OAAGC,MAAM,KAAKJ,OAAOK,UAAU;MAAEC,WAAW;IAAK,CAAA,EAAGC,MAAM,CAACC,UAAAA;AACzD,YAAMA;IACR,CAAA;EACF;EAEMC,SAASC,OAAiC;;AAC9C,YAAMC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,YAAMG,QAAQ,MAAMV,GAAGW,KAAKH,QAAAA;AAC5B,aAAO;QACLI,MAAMF,MAAME;QACZC,UAAUC,KAAKC,OAAOP,QAAAA,KAAa;QACnCQ,kBAAkBN,MAAMO,MAAMC,YAAW;MAC3C;IACF;;EAEA,OAAOpB,UAAUD,QAAuB;AACtC,QAAIA,OAAOsB,WAAW,SAAS;AAC7B,aAAO;IACT;AACA,WAAO;EACT;EAEAV,YAAYW,UAAkB;AAC5B,WAAOb,KAAKc,KAAK,KAAKxB,OAAOK,UAAUkB,QAAAA;EACzC;EAEME,OAAOf,OAAgC;;AAC3C,UAAI;AACF,cAAMP,GAAGuB,OAAO,KAAKd,YAAYF,KAAAA,CAAAA;AACjC,eAAO;MACT,SAAQ;AACN,eAAO;MACT;IACF;;EAEMiB,IAAIjB,OAAckB,SAA8D;;AACpF,YAAMjB,WAAW,KAAKC,YAAYF,KAAAA;AAElC,UAAI,OAAOkB,YAAY,YAAYA,mBAAmBC,QAAQ;AAC5D,cAAM1B,GAAG2B,UAAUnB,UAAUiB,OAAAA;MAC/B,WAAW,OAAOA,YAAY,YAAY,EAAEA,mBAAmBG,cAAAA,UAAS;AACtE,cAAM5B,GAAG2B,UAAUnB,UAAUqB,KAAKC,UAAUL,SAAS,MAAM,CAAA,CAAA;MAC7D,WAAW,OAAOA,YAAY,YAAYA,mBAAmBG,cAAAA,SAAQ;AACnE,cAAMG,kBAAcC,6BAAkBxB,QAAAA;AACtC,cAAM,IAAIyB,QAAQ,CAACC,SAASC,WAAAA;AACzBV,kBAAmBW,KAAKL,WAAAA;AACxBN,kBAAmBY,GAAG,OAAOH,OAAAA;AAC7BT,kBAAmBY,GAAG,SAASF,MAAAA;QAClC,CAAA;MACF,OAAO;AACL,cAAM,IAAIpC,MAAM,0BAAA;MAClB;AAEA,aAAO;IACT;;EAEMuC,QAAQ/B,OAA+B;;AAC3C,YAAMC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,YAAMkB,UAAU,MAAMzB,GAAGuC,SAAS/B,UAAU,OAAA;AAC5C,aAAOqB,KAAKW,MAAMf,OAAAA;IACpB;;EAEMgB,UAAUlC,OAAcmC,WAA2B,SAA0B;;AACjF,YAAMlC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,aAAO,MAAMP,GAAGuC,SAAS/B,UAAUkC,QAAAA;IACrC;;EAEMC,UAAUpC,OAA+B;;AAC7C,YAAMC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,aAAO,MAAMP,GAAGuC,SAAS/B,QAAAA;IAC3B;;EAEMoC,UAAUrC,OAAmC;;AACjD,YAAMC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,iBAAOsC,4BAAiBrC,QAAAA;IAC1B;;EAEMsC,OAAOvC,OAAgC;;AAC3C,YAAMC,WAAW,KAAKC,YAAYF,KAAAA;AAClC,YAAMP,GAAG+C,OAAOvC,QAAAA;AAChB,aAAO;IACT;;AACF;AA1FkCZ;AAA3B,IAAMD,eAAN;","names":["LocalStorage","Storage","config","canHandle","Error","fs","mkdir","basePath","recursive","catch","error","metadata","path","fullPath","getFullPath","stats","stat","size","mimeType","mime","lookup","lastModifiedDate","mtime","toISOString","engine","filePath","join","exists","access","put","content","Buffer","writeFile","Stream","JSON","stringify","writeStream","createWriteStream","Promise","resolve","reject","pipe","on","getJson","readFile","parse","getString","encoding","getBuffer","getStream","createReadStream","delete","unlink"]}
package/dist/Storage.d.ts DELETED
@@ -1,20 +0,0 @@
1
- import { ReadStream } from 'fs';
2
- import { Stream } from 'stream';
3
- import { StorageConfig, Metadata } from './types.js';
4
- import '@aws-sdk/client-s3';
5
-
6
- declare abstract class Storage {
7
- protected config: StorageConfig;
8
- constructor(config: StorageConfig);
9
- static canHandle(config: StorageConfig): boolean;
10
- abstract exists(path: string): Promise<boolean>;
11
- abstract put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;
12
- abstract getJson(path: string): Promise<object>;
13
- abstract getString(path: string): Promise<string>;
14
- abstract getBuffer(path: string): Promise<Buffer>;
15
- abstract getStream(path: string): Promise<ReadStream>;
16
- abstract delete(path: string): Promise<boolean>;
17
- abstract metadata(path: string): Promise<Metadata>;
18
- }
19
-
20
- export { Storage };
package/dist/Storage.js DELETED
@@ -1,42 +0,0 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
7
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
8
- var __export = (target, all) => {
9
- for (var name in all)
10
- __defProp(target, name, { get: all[name], enumerable: true });
11
- };
12
- var __copyProps = (to, from, except, desc) => {
13
- if (from && typeof from === "object" || typeof from === "function") {
14
- for (let key of __getOwnPropNames(from))
15
- if (!__hasOwnProp.call(to, key) && key !== except)
16
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
- }
18
- return to;
19
- };
20
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
21
- var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
22
- var Storage_exports = {};
23
- __export(Storage_exports, {
24
- Storage: () => Storage
25
- });
26
- module.exports = __toCommonJS(Storage_exports);
27
- const _Storage = class _Storage {
28
- constructor(config) {
29
- __publicField(this, "config");
30
- this.config = config;
31
- }
32
- static canHandle(config) {
33
- throw new Error("Method not implemented.");
34
- }
35
- };
36
- __name(_Storage, "Storage");
37
- let Storage = _Storage;
38
- // Annotate the CommonJS export names for ESM import in node:
39
- 0 && (module.exports = {
40
- Storage
41
- });
42
- //# sourceMappingURL=Storage.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/Storage.ts"],"sourcesContent":["import { ReadStream } from 'fs';\nimport { Stream } from 'stream';\nimport { Metadata } from './types';\nimport { StorageConfig } from './types';\n\nexport abstract class Storage {\n constructor(protected config: StorageConfig) {}\n\n static canHandle(config: StorageConfig): boolean {\n throw new Error('Method not implemented.');\n }\n\n abstract exists(path: string): Promise<boolean>;\n abstract put(path: string, content: string | object | Stream | Buffer): Promise<boolean>;\n abstract getJson(path: string): Promise<object>;\n abstract getString(path: string): Promise<string>;\n abstract getBuffer(path: string): Promise<Buffer>;\n abstract getStream(path: string): Promise<ReadStream>;\n abstract delete(path: string): Promise<boolean>;\n abstract metadata(path: string): Promise<Metadata>;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAKA;;;;;AAAO,MAAeA,WAAf,MAAeA,SAAAA;EACpB,YAAsBC,QAAuB;;SAAvBA,SAAAA;EAAwB;EAE9C,OAAOC,UAAUD,QAAgC;AAC/C,UAAM,IAAIE,MAAM,yBAAA;EAClB;AAUF;AAfsBH;AAAf,IAAeA,UAAf;","names":["Storage","config","canHandle","Error"]}
@@ -1,13 +0,0 @@
1
- import { Storage } from './Storage.js';
2
- import { StorageConfig } from './types.js';
3
- import 'fs';
4
- import 'stream';
5
- import '@aws-sdk/client-s3';
6
-
7
- declare class StorageFactory {
8
- static storageEngines: (typeof Storage)[];
9
- registerStorageEngine(engine: typeof Storage): void;
10
- static create(config: StorageConfig): Storage;
11
- }
12
-
13
- export { StorageFactory };
@@ -1,52 +0,0 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
7
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
8
- var __export = (target, all) => {
9
- for (var name in all)
10
- __defProp(target, name, { get: all[name], enumerable: true });
11
- };
12
- var __copyProps = (to, from, except, desc) => {
13
- if (from && typeof from === "object" || typeof from === "function") {
14
- for (let key of __getOwnPropNames(from))
15
- if (!__hasOwnProp.call(to, key) && key !== except)
16
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
- }
18
- return to;
19
- };
20
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
21
- var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
22
- var StorageFactory_exports = {};
23
- __export(StorageFactory_exports, {
24
- StorageFactory: () => StorageFactory
25
- });
26
- module.exports = __toCommonJS(StorageFactory_exports);
27
- var import_AWSS3Storage = require("./AWSS3Storage");
28
- var import_LocalStorage = require("./LocalStorage");
29
- const _StorageFactory = class _StorageFactory {
30
- registerStorageEngine(engine) {
31
- _StorageFactory.storageEngines.push(engine);
32
- }
33
- static create(config) {
34
- for (const engine of _StorageFactory.storageEngines) {
35
- if (engine.canHandle(config)) {
36
- return new engine(config);
37
- }
38
- }
39
- throw new Error("No matchin storage engine found");
40
- }
41
- };
42
- __name(_StorageFactory, "StorageFactory");
43
- __publicField(_StorageFactory, "storageEngines", [
44
- import_LocalStorage.LocalStorage,
45
- import_AWSS3Storage.AWSS3Storage
46
- ]);
47
- let StorageFactory = _StorageFactory;
48
- // Annotate the CommonJS export names for ESM import in node:
49
- 0 && (module.exports = {
50
- StorageFactory
51
- });
52
- //# sourceMappingURL=StorageFactory.js.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../src/StorageFactory.ts"],"sourcesContent":["import { AWSS3Storage } from './AWSS3Storage';\nimport { LocalStorage } from './LocalStorage';\nimport { Storage } from './Storage';\nimport { StorageConfig } from './types';\n\nexport class StorageFactory {\n public static storageEngines: (typeof Storage)[] = [LocalStorage, AWSS3Storage];\n\n registerStorageEngine(engine: typeof Storage) {\n StorageFactory.storageEngines.push(engine);\n }\n\n public static create(config: StorageConfig): Storage {\n for (const engine of StorageFactory.storageEngines) {\n if (engine.canHandle(config)) {\n // @ts-ignore\n return new engine(config);\n }\n }\n throw new Error('No matchin storage engine found');\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;AAAA,0BAA6B;AAC7B,0BAA6B;AAItB,MAAMA,kBAAN,MAAMA,gBAAAA;EAGXC,sBAAsBC,QAAwB;AAC5CF,oBAAeG,eAAeC,KAAKF,MAAAA;EACrC;EAEA,OAAcG,OAAOC,QAAgC;AACnD,eAAWJ,UAAUF,gBAAeG,gBAAgB;AAClD,UAAID,OAAOK,UAAUD,MAAAA,GAAS;AAE5B,eAAO,IAAIJ,OAAOI,MAAAA;MACpB;IACF;AACA,UAAM,IAAIE,MAAM,iCAAA;EAClB;AACF;AAhBaR;AACX,cADWA,iBACGG,kBAAqC;EAACM;EAAcC;;AAD7D,IAAMV,iBAAN;","names":["StorageFactory","registerStorageEngine","engine","storageEngines","push","create","config","canHandle","Error","LocalStorage","AWSS3Storage"]}