@better-media/adapter-storage-filesystem 0.1.0
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/LICENSE +21 -0
- package/README.md +28 -0
- package/dist/index.d.mts +25 -0
- package/dist/index.d.ts +25 -0
- package/dist/index.js +87 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +80 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +48 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 abenezeratnafu
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
|
|
20
|
+
ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# @better-media/adapter-storage-filesystem
|
|
2
|
+
|
|
3
|
+
Local filesystem storage adapter for the Better Media framework.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Local Storage**: Store files in a directory on your disk.
|
|
8
|
+
- **Node.js**: Uses `fs-extra` and Node.js built-in streams.
|
|
9
|
+
- **MIME Awareness**: Respects and stores MIME information as needed.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm add @better-media/adapter-storage-filesystem
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
import { FileSystemStorageAdapter } from "@better-media/adapter-storage-filesystem";
|
|
21
|
+
|
|
22
|
+
const storage = new FileSystemStorageAdapter({
|
|
23
|
+
baseDir: "./uploads",
|
|
24
|
+
baseUrl: "http://localhost:3000/public",
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
For more, visit [better-media.dev/docs/adapters/storage-filesystem](https://better-media.dev/docs/adapters/storage-filesystem).
|
package/dist/index.d.mts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { StorageAdapter } from '@better-media/core';
|
|
2
|
+
|
|
3
|
+
interface FilesystemStorageConfig {
|
|
4
|
+
/** Base directory where all files are stored. Keys are resolved relative to this path. */
|
|
5
|
+
baseDir: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Filesystem storage adapter for development or single-node deployments.
|
|
9
|
+
* Stores files on disk under a configurable base directory.
|
|
10
|
+
*
|
|
11
|
+
* Works well with Multer in Express/NestJS - Multer saves to disk, then you
|
|
12
|
+
* can read the file and put it into this storage using the desired key.
|
|
13
|
+
*/
|
|
14
|
+
declare class FileSystemStorageAdapter implements StorageAdapter {
|
|
15
|
+
private readonly baseDir;
|
|
16
|
+
constructor(config: FilesystemStorageConfig);
|
|
17
|
+
get(key: string): Promise<Buffer | null>;
|
|
18
|
+
put(key: string, value: Buffer): Promise<void>;
|
|
19
|
+
delete(key: string): Promise<void>;
|
|
20
|
+
exists(key: string): Promise<boolean>;
|
|
21
|
+
getSize(key: string): Promise<number | null>;
|
|
22
|
+
getStream(key: string): Promise<ReadableStream<Uint8Array> | null>;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export { FileSystemStorageAdapter, type FilesystemStorageConfig };
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { StorageAdapter } from '@better-media/core';
|
|
2
|
+
|
|
3
|
+
interface FilesystemStorageConfig {
|
|
4
|
+
/** Base directory where all files are stored. Keys are resolved relative to this path. */
|
|
5
|
+
baseDir: string;
|
|
6
|
+
}
|
|
7
|
+
/**
|
|
8
|
+
* Filesystem storage adapter for development or single-node deployments.
|
|
9
|
+
* Stores files on disk under a configurable base directory.
|
|
10
|
+
*
|
|
11
|
+
* Works well with Multer in Express/NestJS - Multer saves to disk, then you
|
|
12
|
+
* can read the file and put it into this storage using the desired key.
|
|
13
|
+
*/
|
|
14
|
+
declare class FileSystemStorageAdapter implements StorageAdapter {
|
|
15
|
+
private readonly baseDir;
|
|
16
|
+
constructor(config: FilesystemStorageConfig);
|
|
17
|
+
get(key: string): Promise<Buffer | null>;
|
|
18
|
+
put(key: string, value: Buffer): Promise<void>;
|
|
19
|
+
delete(key: string): Promise<void>;
|
|
20
|
+
exists(key: string): Promise<boolean>;
|
|
21
|
+
getSize(key: string): Promise<number | null>;
|
|
22
|
+
getStream(key: string): Promise<ReadableStream<Uint8Array> | null>;
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
export { FileSystemStorageAdapter, type FilesystemStorageConfig };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
'use strict';
|
|
2
|
+
|
|
3
|
+
var fs = require('fs/promises');
|
|
4
|
+
var fs$1 = require('fs');
|
|
5
|
+
var path = require('path');
|
|
6
|
+
var stream = require('stream');
|
|
7
|
+
|
|
8
|
+
function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
9
|
+
|
|
10
|
+
var fs__default = /*#__PURE__*/_interopDefault(fs);
|
|
11
|
+
var path__default = /*#__PURE__*/_interopDefault(path);
|
|
12
|
+
|
|
13
|
+
// src/index.ts
|
|
14
|
+
function resolveSafePath(baseDir, key) {
|
|
15
|
+
const base = path__default.default.resolve(baseDir);
|
|
16
|
+
const resolved = path__default.default.resolve(base, key);
|
|
17
|
+
const relative = path__default.default.relative(base, resolved);
|
|
18
|
+
if (relative.startsWith("..") || path__default.default.isAbsolute(relative)) {
|
|
19
|
+
throw new Error(`Storage key resolves outside base directory: ${key}`);
|
|
20
|
+
}
|
|
21
|
+
return resolved;
|
|
22
|
+
}
|
|
23
|
+
var FileSystemStorageAdapter = class {
|
|
24
|
+
baseDir;
|
|
25
|
+
constructor(config) {
|
|
26
|
+
this.baseDir = path__default.default.resolve(config.baseDir);
|
|
27
|
+
}
|
|
28
|
+
async get(key) {
|
|
29
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
30
|
+
try {
|
|
31
|
+
return await fs__default.default.readFile(filePath);
|
|
32
|
+
} catch (err) {
|
|
33
|
+
if (isNotFoundError(err)) return null;
|
|
34
|
+
throw err;
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
async put(key, value) {
|
|
38
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
39
|
+
const dir = path__default.default.dirname(filePath);
|
|
40
|
+
await fs__default.default.mkdir(dir, { recursive: true });
|
|
41
|
+
await fs__default.default.writeFile(filePath, value);
|
|
42
|
+
}
|
|
43
|
+
async delete(key) {
|
|
44
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
45
|
+
try {
|
|
46
|
+
await fs__default.default.unlink(filePath);
|
|
47
|
+
} catch (err) {
|
|
48
|
+
if (isNotFoundError(err)) return;
|
|
49
|
+
throw err;
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
async exists(key) {
|
|
53
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
54
|
+
try {
|
|
55
|
+
await fs__default.default.access(filePath);
|
|
56
|
+
return true;
|
|
57
|
+
} catch {
|
|
58
|
+
return false;
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
async getSize(key) {
|
|
62
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
63
|
+
try {
|
|
64
|
+
const stat = await fs__default.default.stat(filePath);
|
|
65
|
+
return stat.isFile() ? stat.size : null;
|
|
66
|
+
} catch {
|
|
67
|
+
return null;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
async getStream(key) {
|
|
71
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
72
|
+
try {
|
|
73
|
+
await fs__default.default.access(filePath);
|
|
74
|
+
} catch {
|
|
75
|
+
return null;
|
|
76
|
+
}
|
|
77
|
+
const nodeStream = fs$1.createReadStream(filePath);
|
|
78
|
+
return stream.Readable.toWeb(nodeStream);
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
function isNotFoundError(err) {
|
|
82
|
+
return err instanceof Error && err.code === "ENOENT";
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
exports.FileSystemStorageAdapter = FileSystemStorageAdapter;
|
|
86
|
+
//# sourceMappingURL=index.js.map
|
|
87
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":["path","fs","createReadStream","Readable"],"mappings":";;;;;;;;;;;;;AAeA,SAAS,eAAA,CAAgB,SAAiB,GAAA,EAAqB;AAC7D,EAAA,MAAM,IAAA,GAAOA,qBAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACjC,EAAA,MAAM,QAAA,GAAWA,qBAAA,CAAK,OAAA,CAAQ,IAAA,EAAM,GAAG,CAAA;AACvC,EAAA,MAAM,QAAA,GAAWA,qBAAA,CAAK,QAAA,CAAS,IAAA,EAAM,QAAQ,CAAA;AAC7C,EAAA,IAAI,SAAS,UAAA,CAAW,IAAI,KAAKA,qBAAA,CAAK,UAAA,CAAW,QAAQ,CAAA,EAAG;AAC1D,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,GAAG,CAAA,CAAE,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,QAAA;AACT;AASO,IAAM,2BAAN,MAAyD;AAAA,EAC7C,OAAA;AAAA,EAEjB,YAAY,MAAA,EAAiC;AAC3C,IAAA,IAAA,CAAK,OAAA,GAAUA,qBAAA,CAAK,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,EAC5C;AAAA,EAEA,MAAM,IAAI,GAAA,EAAqC;AAC7C,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,OAAO,MAAMC,mBAAA,CAAG,QAAA,CAAS,QAAQ,CAAA;AAAA,IACnC,SAAS,GAAA,EAAK;AACZ,MAAA,IAAI,eAAA,CAAgB,GAAG,CAAA,EAAG,OAAO,IAAA;AACjC,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,GAAA,CAAI,GAAA,EAAa,KAAA,EAA8B;AACnD,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,MAAM,GAAA,GAAMD,qBAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACjC,IAAA,MAAMC,oBAAG,KAAA,CAAM,GAAA,EAAK,EAAE,SAAA,EAAW,MAAM,CAAA;AACvC,IAAA,MAAMA,mBAAA,CAAG,SAAA,CAAU,QAAA,EAAU,KAAK,CAAA;AAAA,EACpC;AAAA,EAEA,MAAM,OAAO,GAAA,EAA4B;AACvC,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAMA,mBAAA,CAAG,OAAO,QAAQ,CAAA;AAAA,IAC1B,SAAS,GAAA,EAAK;AACZ,MAAA,IAAI,eAAA,CAAgB,GAAG,CAAA,EAAG;AAC1B,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,GAAA,EAA+B;AAC1C,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAMA,mBAAA,CAAG,OAAO,QAAQ,CAAA;AACxB,MAAA,OAAO,IAAA;AAAA,IACT,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,KAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,QAAQ,GAAA,EAAqC;AACjD,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAMA,mBAAA,CAAG,IAAA,CAAK,QAAQ,CAAA;AACnC,MAAA,OAAO,IAAA,CAAK,MAAA,EAAO,GAAI,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,IACrC,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,UAAU,GAAA,EAAyD;AACvE,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAMA,mBAAA,CAAG,OAAO,QAAQ,CAAA;AAAA,IAC1B,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,MAAM,UAAA,GAAaC,sBAAiB,QAAQ,CAAA;AAC5C,IAAA,OAAOC,eAAA,CAAS,MAAM,UAAU,CAAA;AAAA,EAClC;AACF;AAEA,SAAS,gBAAgB,GAAA,EAAuB;AAC9C,EAAA,OAAO,GAAA,YAAe,KAAA,IAAU,GAAA,CAA8B,IAAA,KAAS,QAAA;AACzE","file":"index.js","sourcesContent":["import fs from \"node:fs/promises\";\nimport { createReadStream } from \"node:fs\";\nimport path from \"node:path\";\nimport { Readable } from \"node:stream\";\nimport type { StorageAdapter } from \"@better-media/core\";\n\nexport interface FilesystemStorageConfig {\n /** Base directory where all files are stored. Keys are resolved relative to this path. */\n baseDir: string;\n}\n\n/**\n * Resolve a storage key to a safe filesystem path inside baseDir.\n * Prevents directory traversal (e.g. \"../../etc/passwd\").\n */\nfunction resolveSafePath(baseDir: string, key: string): string {\n const base = path.resolve(baseDir);\n const resolved = path.resolve(base, key);\n const relative = path.relative(base, resolved);\n if (relative.startsWith(\"..\") || path.isAbsolute(relative)) {\n throw new Error(`Storage key resolves outside base directory: ${key}`);\n }\n return resolved;\n}\n\n/**\n * Filesystem storage adapter for development or single-node deployments.\n * Stores files on disk under a configurable base directory.\n *\n * Works well with Multer in Express/NestJS - Multer saves to disk, then you\n * can read the file and put it into this storage using the desired key.\n */\nexport class FileSystemStorageAdapter implements StorageAdapter {\n private readonly baseDir: string;\n\n constructor(config: FilesystemStorageConfig) {\n this.baseDir = path.resolve(config.baseDir);\n }\n\n async get(key: string): Promise<Buffer | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n return await fs.readFile(filePath);\n } catch (err) {\n if (isNotFoundError(err)) return null;\n throw err;\n }\n }\n\n async put(key: string, value: Buffer): Promise<void> {\n const filePath = resolveSafePath(this.baseDir, key);\n const dir = path.dirname(filePath);\n await fs.mkdir(dir, { recursive: true });\n await fs.writeFile(filePath, value);\n }\n\n async delete(key: string): Promise<void> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.unlink(filePath);\n } catch (err) {\n if (isNotFoundError(err)) return;\n throw err;\n }\n }\n\n async exists(key: string): Promise<boolean> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.access(filePath);\n return true;\n } catch {\n return false;\n }\n }\n\n async getSize(key: string): Promise<number | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n const stat = await fs.stat(filePath);\n return stat.isFile() ? stat.size : null;\n } catch {\n return null;\n }\n }\n\n async getStream(key: string): Promise<ReadableStream<Uint8Array> | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.access(filePath);\n } catch {\n return null;\n }\n const nodeStream = createReadStream(filePath);\n return Readable.toWeb(nodeStream) as ReadableStream<Uint8Array>;\n }\n}\n\nfunction isNotFoundError(err: unknown): boolean {\n return err instanceof Error && (err as NodeJS.ErrnoException).code === \"ENOENT\";\n}\n"]}
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import fs from 'fs/promises';
|
|
2
|
+
import { createReadStream } from 'fs';
|
|
3
|
+
import path from 'path';
|
|
4
|
+
import { Readable } from 'stream';
|
|
5
|
+
|
|
6
|
+
// src/index.ts
|
|
7
|
+
function resolveSafePath(baseDir, key) {
|
|
8
|
+
const base = path.resolve(baseDir);
|
|
9
|
+
const resolved = path.resolve(base, key);
|
|
10
|
+
const relative = path.relative(base, resolved);
|
|
11
|
+
if (relative.startsWith("..") || path.isAbsolute(relative)) {
|
|
12
|
+
throw new Error(`Storage key resolves outside base directory: ${key}`);
|
|
13
|
+
}
|
|
14
|
+
return resolved;
|
|
15
|
+
}
|
|
16
|
+
var FileSystemStorageAdapter = class {
|
|
17
|
+
baseDir;
|
|
18
|
+
constructor(config) {
|
|
19
|
+
this.baseDir = path.resolve(config.baseDir);
|
|
20
|
+
}
|
|
21
|
+
async get(key) {
|
|
22
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
23
|
+
try {
|
|
24
|
+
return await fs.readFile(filePath);
|
|
25
|
+
} catch (err) {
|
|
26
|
+
if (isNotFoundError(err)) return null;
|
|
27
|
+
throw err;
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
async put(key, value) {
|
|
31
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
32
|
+
const dir = path.dirname(filePath);
|
|
33
|
+
await fs.mkdir(dir, { recursive: true });
|
|
34
|
+
await fs.writeFile(filePath, value);
|
|
35
|
+
}
|
|
36
|
+
async delete(key) {
|
|
37
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
38
|
+
try {
|
|
39
|
+
await fs.unlink(filePath);
|
|
40
|
+
} catch (err) {
|
|
41
|
+
if (isNotFoundError(err)) return;
|
|
42
|
+
throw err;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
async exists(key) {
|
|
46
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
47
|
+
try {
|
|
48
|
+
await fs.access(filePath);
|
|
49
|
+
return true;
|
|
50
|
+
} catch {
|
|
51
|
+
return false;
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
async getSize(key) {
|
|
55
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
56
|
+
try {
|
|
57
|
+
const stat = await fs.stat(filePath);
|
|
58
|
+
return stat.isFile() ? stat.size : null;
|
|
59
|
+
} catch {
|
|
60
|
+
return null;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
async getStream(key) {
|
|
64
|
+
const filePath = resolveSafePath(this.baseDir, key);
|
|
65
|
+
try {
|
|
66
|
+
await fs.access(filePath);
|
|
67
|
+
} catch {
|
|
68
|
+
return null;
|
|
69
|
+
}
|
|
70
|
+
const nodeStream = createReadStream(filePath);
|
|
71
|
+
return Readable.toWeb(nodeStream);
|
|
72
|
+
}
|
|
73
|
+
};
|
|
74
|
+
function isNotFoundError(err) {
|
|
75
|
+
return err instanceof Error && err.code === "ENOENT";
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export { FileSystemStorageAdapter };
|
|
79
|
+
//# sourceMappingURL=index.mjs.map
|
|
80
|
+
//# sourceMappingURL=index.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAeA,SAAS,eAAA,CAAgB,SAAiB,GAAA,EAAqB;AAC7D,EAAA,MAAM,IAAA,GAAO,IAAA,CAAK,OAAA,CAAQ,OAAO,CAAA;AACjC,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,OAAA,CAAQ,IAAA,EAAM,GAAG,CAAA;AACvC,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,QAAA,CAAS,IAAA,EAAM,QAAQ,CAAA;AAC7C,EAAA,IAAI,SAAS,UAAA,CAAW,IAAI,KAAK,IAAA,CAAK,UAAA,CAAW,QAAQ,CAAA,EAAG;AAC1D,IAAA,MAAM,IAAI,KAAA,CAAM,CAAA,6CAAA,EAAgD,GAAG,CAAA,CAAE,CAAA;AAAA,EACvE;AACA,EAAA,OAAO,QAAA;AACT;AASO,IAAM,2BAAN,MAAyD;AAAA,EAC7C,OAAA;AAAA,EAEjB,YAAY,MAAA,EAAiC;AAC3C,IAAA,IAAA,CAAK,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAA,CAAO,OAAO,CAAA;AAAA,EAC5C;AAAA,EAEA,MAAM,IAAI,GAAA,EAAqC;AAC7C,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,OAAO,MAAM,EAAA,CAAG,QAAA,CAAS,QAAQ,CAAA;AAAA,IACnC,SAAS,GAAA,EAAK;AACZ,MAAA,IAAI,eAAA,CAAgB,GAAG,CAAA,EAAG,OAAO,IAAA;AACjC,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,GAAA,CAAI,GAAA,EAAa,KAAA,EAA8B;AACnD,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,MAAM,GAAA,GAAM,IAAA,CAAK,OAAA,CAAQ,QAAQ,CAAA;AACjC,IAAA,MAAM,GAAG,KAAA,CAAM,GAAA,EAAK,EAAE,SAAA,EAAW,MAAM,CAAA;AACvC,IAAA,MAAM,EAAA,CAAG,SAAA,CAAU,QAAA,EAAU,KAAK,CAAA;AAAA,EACpC;AAAA,EAEA,MAAM,OAAO,GAAA,EAA4B;AACvC,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,OAAO,QAAQ,CAAA;AAAA,IAC1B,SAAS,GAAA,EAAK;AACZ,MAAA,IAAI,eAAA,CAAgB,GAAG,CAAA,EAAG;AAC1B,MAAA,MAAM,GAAA;AAAA,IACR;AAAA,EACF;AAAA,EAEA,MAAM,OAAO,GAAA,EAA+B;AAC1C,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,OAAO,QAAQ,CAAA;AACxB,MAAA,OAAO,IAAA;AAAA,IACT,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,KAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,QAAQ,GAAA,EAAqC;AACjD,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAM,IAAA,GAAO,MAAM,EAAA,CAAG,IAAA,CAAK,QAAQ,CAAA;AACnC,MAAA,OAAO,IAAA,CAAK,MAAA,EAAO,GAAI,IAAA,CAAK,IAAA,GAAO,IAAA;AAAA,IACrC,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,IAAA;AAAA,IACT;AAAA,EACF;AAAA,EAEA,MAAM,UAAU,GAAA,EAAyD;AACvE,IAAA,MAAM,QAAA,GAAW,eAAA,CAAgB,IAAA,CAAK,OAAA,EAAS,GAAG,CAAA;AAClD,IAAA,IAAI;AACF,MAAA,MAAM,EAAA,CAAG,OAAO,QAAQ,CAAA;AAAA,IAC1B,CAAA,CAAA,MAAQ;AACN,MAAA,OAAO,IAAA;AAAA,IACT;AACA,IAAA,MAAM,UAAA,GAAa,iBAAiB,QAAQ,CAAA;AAC5C,IAAA,OAAO,QAAA,CAAS,MAAM,UAAU,CAAA;AAAA,EAClC;AACF;AAEA,SAAS,gBAAgB,GAAA,EAAuB;AAC9C,EAAA,OAAO,GAAA,YAAe,KAAA,IAAU,GAAA,CAA8B,IAAA,KAAS,QAAA;AACzE","file":"index.mjs","sourcesContent":["import fs from \"node:fs/promises\";\nimport { createReadStream } from \"node:fs\";\nimport path from \"node:path\";\nimport { Readable } from \"node:stream\";\nimport type { StorageAdapter } from \"@better-media/core\";\n\nexport interface FilesystemStorageConfig {\n /** Base directory where all files are stored. Keys are resolved relative to this path. */\n baseDir: string;\n}\n\n/**\n * Resolve a storage key to a safe filesystem path inside baseDir.\n * Prevents directory traversal (e.g. \"../../etc/passwd\").\n */\nfunction resolveSafePath(baseDir: string, key: string): string {\n const base = path.resolve(baseDir);\n const resolved = path.resolve(base, key);\n const relative = path.relative(base, resolved);\n if (relative.startsWith(\"..\") || path.isAbsolute(relative)) {\n throw new Error(`Storage key resolves outside base directory: ${key}`);\n }\n return resolved;\n}\n\n/**\n * Filesystem storage adapter for development or single-node deployments.\n * Stores files on disk under a configurable base directory.\n *\n * Works well with Multer in Express/NestJS - Multer saves to disk, then you\n * can read the file and put it into this storage using the desired key.\n */\nexport class FileSystemStorageAdapter implements StorageAdapter {\n private readonly baseDir: string;\n\n constructor(config: FilesystemStorageConfig) {\n this.baseDir = path.resolve(config.baseDir);\n }\n\n async get(key: string): Promise<Buffer | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n return await fs.readFile(filePath);\n } catch (err) {\n if (isNotFoundError(err)) return null;\n throw err;\n }\n }\n\n async put(key: string, value: Buffer): Promise<void> {\n const filePath = resolveSafePath(this.baseDir, key);\n const dir = path.dirname(filePath);\n await fs.mkdir(dir, { recursive: true });\n await fs.writeFile(filePath, value);\n }\n\n async delete(key: string): Promise<void> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.unlink(filePath);\n } catch (err) {\n if (isNotFoundError(err)) return;\n throw err;\n }\n }\n\n async exists(key: string): Promise<boolean> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.access(filePath);\n return true;\n } catch {\n return false;\n }\n }\n\n async getSize(key: string): Promise<number | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n const stat = await fs.stat(filePath);\n return stat.isFile() ? stat.size : null;\n } catch {\n return null;\n }\n }\n\n async getStream(key: string): Promise<ReadableStream<Uint8Array> | null> {\n const filePath = resolveSafePath(this.baseDir, key);\n try {\n await fs.access(filePath);\n } catch {\n return null;\n }\n const nodeStream = createReadStream(filePath);\n return Readable.toWeb(nodeStream) as ReadableStream<Uint8Array>;\n }\n}\n\nfunction isNotFoundError(err: unknown): boolean {\n return err instanceof Error && (err as NodeJS.ErrnoException).code === \"ENOENT\";\n}\n"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@better-media/adapter-storage-filesystem",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Filesystem storage adapter for Better Media",
|
|
5
|
+
"main": "./dist/index.js",
|
|
6
|
+
"module": "./dist/index.mjs",
|
|
7
|
+
"types": "./dist/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./dist/index.d.ts",
|
|
11
|
+
"import": "./dist/index.mjs",
|
|
12
|
+
"require": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"files": [
|
|
16
|
+
"dist",
|
|
17
|
+
"README.md"
|
|
18
|
+
],
|
|
19
|
+
"dependencies": {
|
|
20
|
+
"@better-media/core": "0.1.0"
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"better-media",
|
|
24
|
+
"storage",
|
|
25
|
+
"filesystem",
|
|
26
|
+
"adapter"
|
|
27
|
+
],
|
|
28
|
+
"author": "Abenezer Atnafu",
|
|
29
|
+
"license": "MIT",
|
|
30
|
+
"repository": {
|
|
31
|
+
"type": "git",
|
|
32
|
+
"url": "git+https://github.com/AbenezerAtnafu/better-media.git"
|
|
33
|
+
},
|
|
34
|
+
"homepage": "https://better-media.dev",
|
|
35
|
+
"bugs": {
|
|
36
|
+
"url": "https://github.com/AbenezerAtnafu/better-media/issues"
|
|
37
|
+
},
|
|
38
|
+
"publishConfig": {
|
|
39
|
+
"access": "public"
|
|
40
|
+
},
|
|
41
|
+
"scripts": {
|
|
42
|
+
"build": "tsup",
|
|
43
|
+
"dev": "tsup --watch",
|
|
44
|
+
"typecheck": "tsc --noEmit",
|
|
45
|
+
"lint": "eslint .",
|
|
46
|
+
"test": "jest"
|
|
47
|
+
}
|
|
48
|
+
}
|