streamby-core 0.24.17 β†’ 0.25.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/README.md CHANGED
@@ -1,242 +1,242 @@
1
- # @streamby/core
2
-
3
- Middleware framework for building storage-agnostic media APIs.
4
- Part of the [StreamBy](https://streamby.nhexa.cl) ecosystem by TerminalCore Labs.
5
-
6
- ---
7
-
8
- ## πŸš€ What is it?
9
-
10
- `@streamby/core` is a plug-and-play middleware for Express (or compatible frameworks) that enables file uploads, listings and **multi-project access** over services like:
11
-
12
- - βœ… AWS S3
13
- - βœ… Google Cloud Storage (soon)
14
- - βœ… Cloudflare R2 (soon)
15
- - βœ… Local/Personal servers (soon)
16
-
17
- It's designed to be installed inside your existing API as a library β€” **no need to run a separate backend**.
18
-
19
- ---
20
-
21
- ## πŸ“¦ Installation
22
-
23
- ```bash
24
- npm install @streamby/core
25
- ```
26
-
27
- ---
28
-
29
- ## 🧱 Basic usage
30
-
31
- ---
32
-
33
- ## πŸ—„οΈ Database Schema Setup
34
-
35
- `@streamby/core` requires a pre-configured database schema for its internal operations. It does not manage database connections directly; instead, it expects the host application to provide initialized connection instances. This ensures full control and flexibility for the host environment.
36
-
37
- The library will only interact with the specified schema and will not touch other schemas in your database. The `reset` option is opt-in and will only drop and recreate the specified `streamby` schema if explicitly set to `true`.
38
-
39
- ### PostgreSQL Example
40
-
41
- ```ts
42
- import { Pool } from "pg";
43
- import { setupStreambyPg } from "@streamby/core/pg/setup"; // Adjust path as per your package structure
44
-
45
- const pool = new Pool({ connectionString: process.env.DATABASE_URL });
46
-
47
- // Call setupStreambyPg to ensure the schema and tables are created
48
- // reset: false (default) ensures idempotency and no data loss
49
- await setupStreambyPg({ pool, schema: "streamby", reset: false });
50
- ```
51
-
52
- ### MongoDB Example
53
-
54
- ```ts
55
- import { MongoClient } from "mongodb";
56
- import { setupStreambyMongo } from "@streamby/core/mongo/setup"; // Adjust path as per your package structure
57
-
58
- const client = new MongoClient(process.env.MONGO_URL!);
59
-
60
- // Connect the MongoDB client
61
- await client.connect();
62
-
63
- // Call setupStreambyMongo to ensure collections and indexes are created
64
- await setupStreambyMongo({ client, dbName: "streamby" });
65
- ```
66
-
67
- ```ts
68
- import express from 'express';
69
- import { createStreamByRouter } from '@streamby/core';
70
-
71
- const app = express();
72
-
73
- app.use('/streamby', createStreamByRouter({
74
- storageProvider: {
75
- type: 's3',
76
- config: {
77
- bucket: 'your-bucket-name',
78
- region: 'your-region',
79
- accessKeyId: 'YOUR_AWS_KEY',
80
- secretAccessKey: 'YOUR_AWS_SECRET'
81
- }
82
- },
83
- authProvider: async (req) => {
84
- // extract token/cookie and validate
85
- return {
86
- userId: 'demo',
87
- projects: ['demo-project'],
88
- role: 'admin',
89
- };
90
- },
91
- projectProvider: async (projectId) => {
92
- // fetch project from your DB
93
- return {
94
- id: projectId,
95
- name: 'Demo Project',
96
- description: 'Demo for StreamBy integration',
97
- rootFolders: [],
98
- settings: { allowUpload: true }
99
- };
100
- }
101
- }));
102
-
103
- app.listen(3000);
104
- ```
105
-
106
- ---
107
-
108
- ## πŸ§ͺ Testing
109
-
110
- ```bash
111
- npm run test
112
- ```
113
-
114
- Unit tests use [Vitest](https://vitest.dev) and [Supertest](https://www.npmjs.com/package/supertest).
115
-
116
- ---
117
-
118
- ## πŸ“ Features
119
-
120
- - πŸ“‚ Multi-project access control
121
- - πŸ” Project-aware file uploads & listings
122
- - 🧹 Modular adapters per storage provider
123
- - 🧰 Built-in testability with mock auth & storage
124
- - ✨ Simple to extend for custom business logic
125
-
126
- ---
127
-
128
- ## πŸ—ΊοΈ API Endpoints
129
-
130
- Here's a summary of the key API endpoints provided by `@streamby/core`:
131
-
132
- ### `GET /streamby/projects`
133
-
134
- Lists all projects accessible by the authenticated user.
135
-
136
- **Query Parameters:**
137
- - `archived`: (Optional) Filter projects by their archived status.
138
- - `true`: Returns only archived projects.
139
- - `false`: Returns only unarchived projects.
140
- - (Omitted): Returns all projects (both archived and unarchived).
141
-
142
- **Example Response:**
143
- ```json
144
- {
145
- "projects": [
146
- {
147
- "id": "project1_id",
148
- "dbType": "nosql",
149
- "name": "My NoSQL Project",
150
- "image": "url_to_image",
151
- "archived": false
152
- },
153
- {
154
- "id": "project2_id",
155
- "dbType": "sql",
156
- "name": "My SQL Project",
157
- "image": "url_to_image",
158
- "archived": true
159
- }
160
- ]
161
- }
162
- ```
163
-
164
- ### `PATCH /streamby/projects/:id/archive`
165
-
166
- Archives a specific project. After archiving, it returns the complete list of projects for the user, including the updated project.
167
-
168
- **Example Response:**
169
- ```json
170
- {
171
- "success": true,
172
- "projects": [
173
- {
174
- "id": "project1_id",
175
- "dbType": "nosql",
176
- "name": "My NoSQL Project",
177
- "image": "url_to_image",
178
- "archived": true
179
- },
180
- {
181
- "id": "project2_id",
182
- "dbType": "sql",
183
- "name": "My SQL Project",
184
- "image": "url_to_image",
185
- "archived": false
186
- }
187
- ]
188
- }
189
- ```
190
-
191
- ### `PATCH /streamby/projects/:id/unarchive`
192
-
193
- Unarchives a specific project. After unarchiving, it returns the complete list of projects for the user, including the updated project.
194
-
195
- **Example Response:**
196
- ```json
197
- {
198
- "success": true,
199
- "projects": [
200
- {
201
- "id": "project1_id",
202
- "dbType": "nosql",
203
- "name": "My NoSQL Project",
204
- "image": "url_to_image",
205
- "archived": false
206
- },
207
- {
208
- "id": "project2_id",
209
- "dbType": "sql",
210
- "name": "My SQL Project",
211
- "image": "url_to_image",
212
- "archived": false
213
- }
214
- ]
215
- }
216
- ```
217
-
218
- ---
219
-
220
- ## 🚣 Roadmap
221
-
222
- - [ ] Support for Google Cloud Storage
223
- - [ ] CLI tool for uploading files
224
- - [ ] Role-based access control middleware
225
- - [ ] Plugin system for extended routes
226
- - [ ] Streaming support (HLS, audio, etc.)
227
-
228
- ---
229
-
230
- ## πŸ§‘β€πŸ’» Maintained by
231
-
232
- **TerminalCore Labs** – part of [Nhexa Entertainment](https://nhexa.cl)
233
- Developed as open-source infrastructure for creative and media-oriented apps.
234
-
235
- Visit us [here](https://terminalcore.cl)
236
-
237
- ---
238
-
239
- ## πŸ“Ÿ License
240
-
241
- [MIT](./LICENSE)
242
-
1
+ # @streamby/core
2
+
3
+ Middleware framework for building storage-agnostic media APIs.
4
+ Part of the [StreamBy](https://streamby.nhexa.cl) ecosystem by TerminalCore Labs.
5
+
6
+ ---
7
+
8
+ ## πŸš€ What is it?
9
+
10
+ `@streamby/core` is a plug-and-play middleware for Express (or compatible frameworks) that enables file uploads, listings and **multi-project access** over services like:
11
+
12
+ - βœ… AWS S3
13
+ - βœ… Google Cloud Storage (soon)
14
+ - βœ… Cloudflare R2 (soon)
15
+ - βœ… Local/Personal servers (soon)
16
+
17
+ It's designed to be installed inside your existing API as a library β€” **no need to run a separate backend**.
18
+
19
+ ---
20
+
21
+ ## πŸ“¦ Installation
22
+
23
+ ```bash
24
+ npm install @streamby/core
25
+ ```
26
+
27
+ ---
28
+
29
+ ## 🧱 Basic usage
30
+
31
+ ---
32
+
33
+ ## πŸ—„οΈ Database Schema Setup
34
+
35
+ `@streamby/core` requires a pre-configured database schema for its internal operations. It does not manage database connections directly; instead, it expects the host application to provide initialized connection instances. This ensures full control and flexibility for the host environment.
36
+
37
+ The library will only interact with the specified schema and will not touch other schemas in your database. The `reset` option is opt-in and will only drop and recreate the specified `streamby` schema if explicitly set to `true`.
38
+
39
+ ### PostgreSQL Example
40
+
41
+ ```ts
42
+ import { Pool } from "pg";
43
+ import { setupStreambyPg } from "@streamby/core/pg/setup"; // Adjust path as per your package structure
44
+
45
+ const pool = new Pool({ connectionString: process.env.DATABASE_URL });
46
+
47
+ // Call setupStreambyPg to ensure the schema and tables are created
48
+ // reset: false (default) ensures idempotency and no data loss
49
+ await setupStreambyPg({ pool, schema: "streamby", reset: false });
50
+ ```
51
+
52
+ ### MongoDB Example
53
+
54
+ ```ts
55
+ import { MongoClient } from "mongodb";
56
+ import { setupStreambyMongo } from "@streamby/core/mongo/setup"; // Adjust path as per your package structure
57
+
58
+ const client = new MongoClient(process.env.MONGO_URL!);
59
+
60
+ // Connect the MongoDB client
61
+ await client.connect();
62
+
63
+ // Call setupStreambyMongo to ensure collections and indexes are created
64
+ await setupStreambyMongo({ client, dbName: "streamby" });
65
+ ```
66
+
67
+ ```ts
68
+ import express from 'express';
69
+ import { createStreamByRouter } from '@streamby/core';
70
+
71
+ const app = express();
72
+
73
+ app.use('/streamby', createStreamByRouter({
74
+ storageProvider: {
75
+ type: 's3',
76
+ config: {
77
+ bucket: 'your-bucket-name',
78
+ region: 'your-region',
79
+ accessKeyId: 'YOUR_AWS_KEY',
80
+ secretAccessKey: 'YOUR_AWS_SECRET'
81
+ }
82
+ },
83
+ authProvider: async (req) => {
84
+ // extract token/cookie and validate
85
+ return {
86
+ userId: 'demo',
87
+ projects: ['demo-project'],
88
+ role: 'admin',
89
+ };
90
+ },
91
+ projectProvider: async (projectId) => {
92
+ // fetch project from your DB
93
+ return {
94
+ id: projectId,
95
+ name: 'Demo Project',
96
+ description: 'Demo for StreamBy integration',
97
+ rootFolders: [],
98
+ settings: { allowUpload: true }
99
+ };
100
+ }
101
+ }));
102
+
103
+ app.listen(3000);
104
+ ```
105
+
106
+ ---
107
+
108
+ ## πŸ§ͺ Testing
109
+
110
+ ```bash
111
+ npm run test
112
+ ```
113
+
114
+ Unit tests use [Vitest](https://vitest.dev) and [Supertest](https://www.npmjs.com/package/supertest).
115
+
116
+ ---
117
+
118
+ ## πŸ“ Features
119
+
120
+ - πŸ“‚ Multi-project access control
121
+ - πŸ” Project-aware file uploads & listings
122
+ - 🧹 Modular adapters per storage provider
123
+ - 🧰 Built-in testability with mock auth & storage
124
+ - ✨ Simple to extend for custom business logic
125
+
126
+ ---
127
+
128
+ ## πŸ—ΊοΈ API Endpoints
129
+
130
+ Here's a summary of the key API endpoints provided by `@streamby/core`:
131
+
132
+ ### `GET /streamby/projects`
133
+
134
+ Lists all projects accessible by the authenticated user.
135
+
136
+ **Query Parameters:**
137
+ - `archived`: (Optional) Filter projects by their archived status.
138
+ - `true`: Returns only archived projects.
139
+ - `false`: Returns only unarchived projects.
140
+ - (Omitted): Returns all projects (both archived and unarchived).
141
+
142
+ **Example Response:**
143
+ ```json
144
+ {
145
+ "projects": [
146
+ {
147
+ "id": "project1_id",
148
+ "dbType": "nosql",
149
+ "name": "My NoSQL Project",
150
+ "image": "url_to_image",
151
+ "archived": false
152
+ },
153
+ {
154
+ "id": "project2_id",
155
+ "dbType": "sql",
156
+ "name": "My SQL Project",
157
+ "image": "url_to_image",
158
+ "archived": true
159
+ }
160
+ ]
161
+ }
162
+ ```
163
+
164
+ ### `PATCH /streamby/projects/:id/archive`
165
+
166
+ Archives a specific project. After archiving, it returns the complete list of projects for the user, including the updated project.
167
+
168
+ **Example Response:**
169
+ ```json
170
+ {
171
+ "success": true,
172
+ "projects": [
173
+ {
174
+ "id": "project1_id",
175
+ "dbType": "nosql",
176
+ "name": "My NoSQL Project",
177
+ "image": "url_to_image",
178
+ "archived": true
179
+ },
180
+ {
181
+ "id": "project2_id",
182
+ "dbType": "sql",
183
+ "name": "My SQL Project",
184
+ "image": "url_to_image",
185
+ "archived": false
186
+ }
187
+ ]
188
+ }
189
+ ```
190
+
191
+ ### `PATCH /streamby/projects/:id/unarchive`
192
+
193
+ Unarchives a specific project. After unarchiving, it returns the complete list of projects for the user, including the updated project.
194
+
195
+ **Example Response:**
196
+ ```json
197
+ {
198
+ "success": true,
199
+ "projects": [
200
+ {
201
+ "id": "project1_id",
202
+ "dbType": "nosql",
203
+ "name": "My NoSQL Project",
204
+ "image": "url_to_image",
205
+ "archived": false
206
+ },
207
+ {
208
+ "id": "project2_id",
209
+ "dbType": "sql",
210
+ "name": "My SQL Project",
211
+ "image": "url_to_image",
212
+ "archived": false
213
+ }
214
+ ]
215
+ }
216
+ ```
217
+
218
+ ---
219
+
220
+ ## 🚣 Roadmap
221
+
222
+ - [ ] Support for Google Cloud Storage
223
+ - [ ] CLI tool for uploading files
224
+ - [ ] Role-based access control middleware
225
+ - [ ] Plugin system for extended routes
226
+ - [ ] Streaming support (HLS, audio, etc.)
227
+
228
+ ---
229
+
230
+ ## πŸ§‘β€πŸ’» Maintained by
231
+
232
+ **TerminalCore Labs** – part of [Nhexa Entertainment](https://nhexa.cl)
233
+ Developed as open-source infrastructure for creative and media-oriented apps.
234
+
235
+ Visit us [here](https://terminalcore.cl)
236
+
237
+ ---
238
+
239
+ ## πŸ“Ÿ License
240
+
241
+ [MIT](./LICENSE)
242
+
@@ -43,56 +43,56 @@ const getConnection = (id) => {
43
43
  exports.getConnection = getConnection;
44
44
  const ensureTablesExist = async (pool) => {
45
45
  try {
46
- await pool.query(`
47
- CREATE SCHEMA IF NOT EXISTS streamby;
48
- CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
49
- CREATE TABLE IF NOT EXISTS streamby.projects (
50
- id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
51
- name VARCHAR(255) NOT NULL,
52
- description TEXT,
53
- image TEXT,
54
- "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
55
- "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW()
56
- );
46
+ await pool.query(`
47
+ CREATE SCHEMA IF NOT EXISTS streamby;
48
+ CREATE EXTENSION IF NOT EXISTS "uuid-ossp";
49
+ CREATE TABLE IF NOT EXISTS streamby.projects (
50
+ id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
51
+ name VARCHAR(255) NOT NULL,
52
+ description TEXT,
53
+ image TEXT,
54
+ "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
55
+ "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW()
56
+ );
57
57
  `);
58
58
  console.log('βœ… "projects" table ensured to exist.');
59
59
  // Ensure dbType column exists and is correctly configured
60
- await pool.query(`
61
- ALTER TABLE streamby.projects ADD COLUMN IF NOT EXISTS "dbType" VARCHAR(50);
60
+ await pool.query(`
61
+ ALTER TABLE streamby.projects ADD COLUMN IF NOT EXISTS "dbType" VARCHAR(50);
62
62
  `);
63
- await pool.query(`
64
- UPDATE streamby.projects SET "dbType" = 'nosql' WHERE "dbType" IS NULL;
63
+ await pool.query(`
64
+ UPDATE streamby.projects SET "dbType" = 'nosql' WHERE "dbType" IS NULL;
65
65
  `);
66
- await pool.query(`
67
- ALTER TABLE streamby.projects ALTER COLUMN "dbType" SET NOT NULL;
66
+ await pool.query(`
67
+ ALTER TABLE streamby.projects ALTER COLUMN "dbType" SET NOT NULL;
68
68
  `);
69
- await pool.query(`
70
- ALTER TABLE streamby.projects ALTER COLUMN "dbType" SET DEFAULT 'nosql';
69
+ await pool.query(`
70
+ ALTER TABLE streamby.projects ALTER COLUMN "dbType" SET DEFAULT 'nosql';
71
71
  `);
72
- await pool.query(`
73
- CREATE TABLE IF NOT EXISTS streamby.exports (
74
- id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
75
- "projectId" UUID NOT NULL REFERENCES streamby.projects(id) ON DELETE CASCADE,
76
- status VARCHAR(50) NOT NULL DEFAULT 'pending',
77
- "filePath" TEXT,
78
- "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
79
- "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW()
80
- );
72
+ await pool.query(`
73
+ CREATE TABLE IF NOT EXISTS streamby.exports (
74
+ id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
75
+ "projectId" UUID NOT NULL REFERENCES streamby.projects(id) ON DELETE CASCADE,
76
+ status VARCHAR(50) NOT NULL DEFAULT 'pending',
77
+ "filePath" TEXT,
78
+ "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
79
+ "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW()
80
+ );
81
81
  `);
82
82
  console.log('βœ… "exports" table ensured to exist.');
83
- await pool.query(`
84
- CREATE TABLE IF NOT EXISTS streamby.project_members (
85
- id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
86
- "projectId" UUID NOT NULL REFERENCES streamby.projects(id) ON DELETE CASCADE,
87
- "userId" VARCHAR(255) NOT NULL,
88
- role VARCHAR(255) NOT NULL DEFAULT 'member',
89
- archived BOOLEAN NOT NULL DEFAULT FALSE,
90
- "archivedBy" VARCHAR(255),
91
- "archivedAt" TIMESTAMP WITH TIME ZONE,
92
- "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
93
- "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
94
- UNIQUE ("projectId", "userId")
95
- );
83
+ await pool.query(`
84
+ CREATE TABLE IF NOT EXISTS streamby.project_members (
85
+ id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
86
+ "projectId" UUID NOT NULL REFERENCES streamby.projects(id) ON DELETE CASCADE,
87
+ "userId" VARCHAR(255) NOT NULL,
88
+ role VARCHAR(255) NOT NULL DEFAULT 'member',
89
+ archived BOOLEAN NOT NULL DEFAULT FALSE,
90
+ "archivedBy" VARCHAR(255),
91
+ "archivedAt" TIMESTAMP WITH TIME ZONE,
92
+ "createdAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
93
+ "updatedAt" TIMESTAMP WITH TIME ZONE DEFAULT NOW(),
94
+ UNIQUE ("projectId", "userId")
95
+ );
96
96
  `);
97
97
  console.log('βœ… "project_members" table ensured to exist.');
98
98
  }
@@ -5,13 +5,13 @@ const createSQLExportTable = async (connection, projectId, exportName, fields) =
5
5
  const slug = exportName.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
6
6
  const tableName = `export_${projectId}_${slug}`;
7
7
  const columns = fields.map(field => `"${field.name}" ${field.type}`).join(',');
8
- const createTableQuery = `
9
- CREATE TABLE IF NOT EXISTS "${tableName}" (
10
- id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
11
- "projectId" UUID NOT NULL,
12
- __metadata JSONB NOT NULL,
13
- ${columns ? `, ${columns}` : ''}
14
- );
8
+ const createTableQuery = `
9
+ CREATE TABLE IF NOT EXISTS "${tableName}" (
10
+ id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
11
+ "projectId" UUID NOT NULL,
12
+ __metadata JSONB NOT NULL,
13
+ ${columns ? `, ${columns}` : ''}
14
+ );
15
15
  `;
16
16
  await connection.query(createTableQuery);
17
17
  console.log(`βœ… Table '${tableName}' created with metadata.`);
@@ -29,11 +29,11 @@ exports.createSQLExportTable = createSQLExportTable;
29
29
  const createSQLRawExportTable = async (connection, projectId, exportName, jsonData) => {
30
30
  const slug = exportName.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '');
31
31
  const tableName = `raw_export_${projectId}_${slug}`;
32
- const createTableQuery = `
33
- CREATE TABLE IF NOT EXISTS "${tableName}" (
34
- id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
35
- data JSONB NOT NULL
36
- );
32
+ const createTableQuery = `
33
+ CREATE TABLE IF NOT EXISTS "${tableName}" (
34
+ id UUID PRIMARY KEY DEFAULT uuid_generate_v4(),
35
+ data JSONB NOT NULL
36
+ );
37
37
  `;
38
38
  await connection.query(createTableQuery);
39
39
  console.log(`βœ… Raw table '${tableName}' created.`);
@@ -1,4 +1,4 @@
1
- import { S3Config, StorageAdapter } from '../../types';
1
+ import { S3Config, StorageAdapter, StorageFileInfo } from '../../types';
2
2
  export declare class S3Adapter implements StorageAdapter {
3
3
  private s3;
4
4
  private bucket;
@@ -8,4 +8,9 @@ export declare class S3Adapter implements StorageAdapter {
8
8
  deleteProjectDirectory(projectId: string): Promise<any>;
9
9
  getPresignedUrl(contentType: string, projectId: string): Promise<any>;
10
10
  getPresignedProjectImageUrl(projectId: string): Promise<any>;
11
+ getPresignedGetUrl(key: string): Promise<string>;
12
+ getPresignedUploadUrl(key: string, contentType: string): Promise<string>;
13
+ deleteFile(key: string): Promise<void>;
14
+ listFilesByCategory(projectId: string, category: string): Promise<StorageFileInfo[]>;
15
+ private inferMimeType;
11
16
  }
@@ -64,5 +64,53 @@ class S3Adapter {
64
64
  const publicUrl = `https://${this.bucket}.s3.amazonaws.com/${key}`;
65
65
  return { url, publicUrl };
66
66
  }
67
+ async getPresignedGetUrl(key) {
68
+ const command = new client_s3_1.GetObjectCommand({ Bucket: this.bucket, Key: key });
69
+ return await (0, s3_request_presigner_1.getSignedUrl)(this.s3, command, { expiresIn: 86400 });
70
+ }
71
+ async getPresignedUploadUrl(key, contentType) {
72
+ const command = new client_s3_1.PutObjectCommand({ Bucket: this.bucket, Key: key, ContentType: contentType });
73
+ return await (0, s3_request_presigner_1.getSignedUrl)(this.s3, command, { expiresIn: 3600 });
74
+ }
75
+ async deleteFile(key) {
76
+ const command = new client_s3_1.DeleteObjectCommand({ Bucket: this.bucket, Key: key });
77
+ await this.s3.send(command);
78
+ }
79
+ async listFilesByCategory(projectId, category) {
80
+ const prefix = `projects/${projectId}/${category}/`;
81
+ const command = new client_s3_1.ListObjectsV2Command({ Bucket: this.bucket, Prefix: prefix });
82
+ const result = await this.s3.send(command);
83
+ if (!result.Contents || result.Contents.length === 0)
84
+ return [];
85
+ const files = await Promise.all(result.Contents
86
+ .filter(obj => obj.Key && obj.Key !== prefix)
87
+ .map(async (obj) => {
88
+ const key = obj.Key;
89
+ const name = key.split('/').pop() || key;
90
+ const url = await this.getPresignedGetUrl(key);
91
+ return {
92
+ key,
93
+ name,
94
+ size: obj.Size || 0,
95
+ url,
96
+ contentType: this.inferMimeType(name),
97
+ lastModified: obj.LastModified?.toISOString() || new Date().toISOString(),
98
+ category,
99
+ };
100
+ }));
101
+ return files;
102
+ }
103
+ inferMimeType(filename) {
104
+ const ext = filename.split('.').pop()?.toLowerCase();
105
+ const mimeMap = {
106
+ jpg: 'image/jpeg', jpeg: 'image/jpeg', png: 'image/png', gif: 'image/gif',
107
+ webp: 'image/webp', svg: 'image/svg+xml', bmp: 'image/bmp', tiff: 'image/tiff',
108
+ mp3: 'audio/mpeg', wav: 'audio/wav', ogg: 'audio/ogg', aac: 'audio/aac', flac: 'audio/flac',
109
+ mp4: 'video/mp4', webm: 'video/webm', mov: 'video/quicktime', avi: 'video/x-msvideo',
110
+ glb: 'model/gltf-binary', gltf: 'model/gltf+json', obj: 'model/obj',
111
+ fbx: 'application/octet-stream', stl: 'model/stl', ply: 'model/ply',
112
+ };
113
+ return ext ? (mimeMap[ext] || 'application/octet-stream') : 'application/octet-stream';
114
+ }
67
115
  }
68
116
  exports.S3Adapter = S3Adapter;
@@ -6,6 +6,28 @@ const file_1 = require("../../services/file");
6
6
  const presign_1 = require("../../services/presign");
7
7
  const storage_1 = require("../../providers/storage");
8
8
  const manager_1 = require("../../models/manager");
9
+ const auth_1 = require("../../utils/auth");
10
+ const VALID_CATEGORIES = ['images', 'audios', 'videos', '3dmodels'];
11
+ const VALID_3D_EXTENSIONS = new Set(['.glb', '.gltf', '.obj', '.fbx', '.stl', '.ply']);
12
+ function validateContentType(contentType, filename, category) {
13
+ if (category === 'images')
14
+ return contentType.startsWith('image/');
15
+ if (category === 'audios')
16
+ return contentType.startsWith('audio/');
17
+ if (category === 'videos')
18
+ return contentType.startsWith('video/');
19
+ if (category === '3dmodels') {
20
+ const ext = filename.split('.').pop()?.toLowerCase();
21
+ return ext ? VALID_3D_EXTENSIONS.has(`.${ext}`) : false;
22
+ }
23
+ return false;
24
+ }
25
+ function sanitizeFilename(filename) {
26
+ const dotIndex = filename.lastIndexOf('.');
27
+ const ext = dotIndex !== -1 ? filename.slice(dotIndex) : '';
28
+ const base = (dotIndex !== -1 ? filename.slice(0, dotIndex) : filename).replace(/[^a-zA-Z0-9._-]/g, '_');
29
+ return `${base}${ext}`;
30
+ }
9
31
  function storageRouter(config) {
10
32
  const router = (0, express_1.Router)();
11
33
  const adapter = config.adapter || (0, storage_1.createStorageProvider)(config.storageProviders);
@@ -55,6 +77,99 @@ function storageRouter(config) {
55
77
  res.status(500).json({ message: 'Failed to delete image', details: err.message });
56
78
  }
57
79
  });
80
+ router.get('/projects/:projectId/storage/:category/upload-url', async (req, res) => {
81
+ try {
82
+ const auth = await config.authProvider(req);
83
+ if (!auth || !auth.userId || !auth.role) {
84
+ return res.status(401).json({ message: 'Unauthorized' });
85
+ }
86
+ const { projectId, category } = req.params;
87
+ const { fileName, contentType } = req.query;
88
+ if (!VALID_CATEGORIES.includes(category)) {
89
+ return res.status(400).json({ message: `Invalid category. Must be one of: ${VALID_CATEGORIES.join(', ')}` });
90
+ }
91
+ if (!fileName || !contentType) {
92
+ return res.status(400).json({ message: 'Query params fileName and contentType are required' });
93
+ }
94
+ if (!validateContentType(contentType, fileName, category)) {
95
+ const hint = category === '3dmodels'
96
+ ? '.glb, .gltf, .obj, .fbx, .stl, or .ply'
97
+ : `${category.slice(0, -1)}/* content type`;
98
+ return res.status(400).json({ message: `Files in the ${category} category must match ${hint}` });
99
+ }
100
+ const project = await Project.findOne({ _id: projectId });
101
+ if (!project) {
102
+ return res.status(404).json({ message: 'Project not found' });
103
+ }
104
+ if (!(0, auth_1.isProjectMember)(project, auth.userId)) {
105
+ return res.status(403).json({ message: 'Unauthorized access' });
106
+ }
107
+ if (!adapter.getPresignedUploadUrl) {
108
+ return res.status(501).json({ message: 'Storage adapter does not support presigned uploads' });
109
+ }
110
+ const key = `projects/${projectId}/${category}/${sanitizeFilename(fileName)}`;
111
+ const url = await adapter.getPresignedUploadUrl(key, contentType);
112
+ res.json({ url });
113
+ }
114
+ catch (err) {
115
+ res.status(500).json({ message: 'Failed to generate upload URL', details: err.message });
116
+ }
117
+ });
118
+ router.get('/projects/:projectId/storage/:category', async (req, res) => {
119
+ try {
120
+ const auth = await config.authProvider(req);
121
+ if (!auth || !auth.userId || !auth.role) {
122
+ return res.status(401).json({ message: 'Unauthorized' });
123
+ }
124
+ const { projectId, category } = req.params;
125
+ if (!VALID_CATEGORIES.includes(category)) {
126
+ return res.status(400).json({ message: `Invalid category. Must be one of: ${VALID_CATEGORIES.join(', ')}` });
127
+ }
128
+ const project = await Project.findOne({ _id: projectId });
129
+ if (!project) {
130
+ return res.status(404).json({ message: 'Project not found' });
131
+ }
132
+ if (!(0, auth_1.isProjectMember)(project, auth.userId)) {
133
+ return res.status(403).json({ message: 'Unauthorized access' });
134
+ }
135
+ if (!adapter.listFilesByCategory) {
136
+ return res.status(501).json({ message: 'Storage adapter does not support listing files by category' });
137
+ }
138
+ const files = await adapter.listFilesByCategory(projectId, category);
139
+ res.json({ data: files });
140
+ }
141
+ catch (err) {
142
+ res.status(500).json({ message: 'Failed to list files', details: err.message });
143
+ }
144
+ });
145
+ router.delete('/projects/:projectId/storage/:category/:key', async (req, res) => {
146
+ try {
147
+ const auth = await config.authProvider(req);
148
+ if (!auth || !auth.userId || !auth.role) {
149
+ return res.status(401).json({ message: 'Unauthorized' });
150
+ }
151
+ const { projectId, category } = req.params;
152
+ const key = decodeURIComponent(req.params.key);
153
+ if (!VALID_CATEGORIES.includes(category)) {
154
+ return res.status(400).json({ message: `Invalid category. Must be one of: ${VALID_CATEGORIES.join(', ')}` });
155
+ }
156
+ const project = await Project.findOne({ _id: projectId });
157
+ if (!project) {
158
+ return res.status(404).json({ message: 'Project not found' });
159
+ }
160
+ if (!(0, auth_1.isProjectMember)(project, auth.userId)) {
161
+ return res.status(403).json({ message: 'Unauthorized access' });
162
+ }
163
+ if (!adapter.deleteFile) {
164
+ return res.status(501).json({ message: 'Storage adapter does not support file deletion' });
165
+ }
166
+ await adapter.deleteFile(key);
167
+ res.json({ message: 'File deleted successfully.' });
168
+ }
169
+ catch (err) {
170
+ res.status(500).json({ message: 'Failed to delete file', details: err.message });
171
+ }
172
+ });
58
173
  router.get('/storages', async (req, res) => {
59
174
  try {
60
175
  const auth = await config.authProvider(req);
@@ -10,12 +10,25 @@ export type StorageProvider = {
10
10
  type: StorageProviderType;
11
11
  config: S3Config;
12
12
  };
13
+ export interface StorageFileInfo {
14
+ key: string;
15
+ name: string;
16
+ size: number;
17
+ url: string;
18
+ contentType: string;
19
+ lastModified: string;
20
+ category: string;
21
+ }
13
22
  export interface StorageAdapter {
14
23
  listFiles(projectId: string): Promise<any[]>;
15
24
  deleteProjectImage: (projectId: string) => Promise<any>;
16
25
  deleteProjectDirectory: (projectId: string) => Promise<any>;
17
26
  getPresignedUrl?: (contentType: string, projectId: string) => Promise<any>;
18
27
  getPresignedProjectImageUrl?: (projectId: string) => Promise<any>;
28
+ getPresignedUploadUrl?: (key: string, contentType: string) => Promise<string>;
29
+ listFilesByCategory?: (projectId: string, category: string) => Promise<StorageFileInfo[]>;
30
+ deleteFile?: (key: string) => Promise<void>;
31
+ getPresignedGetUrl?: (key: string) => Promise<string>;
19
32
  }
20
33
  export interface FieldDefinition {
21
34
  name: string;
@@ -0,0 +1,3 @@
1
+ export declare function encrypt(text: string, secretKey: string): string;
2
+ export declare function decrypt(text: string, secretKey: string): string;
3
+ export declare function hash(text: string): string;
@@ -0,0 +1,32 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.encrypt = encrypt;
7
+ exports.decrypt = decrypt;
8
+ exports.hash = hash;
9
+ const crypto_1 = __importDefault(require("crypto"));
10
+ const ALGORITHM = 'aes-256-cbc';
11
+ const IV_LENGTH = 16;
12
+ function encrypt(text, secretKey) {
13
+ const iv = crypto_1.default.randomBytes(IV_LENGTH);
14
+ const key = crypto_1.default.createHash('sha256').update(String(secretKey)).digest('base64').substr(0, 32);
15
+ const cipher = crypto_1.default.createCipheriv(ALGORITHM, Buffer.from(key), iv);
16
+ let encrypted = cipher.update(text);
17
+ encrypted = Buffer.concat([encrypted, cipher.final()]);
18
+ return iv.toString('hex') + ':' + encrypted.toString('hex');
19
+ }
20
+ function decrypt(text, secretKey) {
21
+ const textParts = text.split(':');
22
+ const iv = Buffer.from(textParts.shift(), 'hex');
23
+ const encryptedText = Buffer.from(textParts.join(':'), 'hex');
24
+ const key = crypto_1.default.createHash('sha256').update(String(secretKey)).digest('base64').substr(0, 32);
25
+ const decipher = crypto_1.default.createDecipheriv(ALGORITHM, Buffer.from(key), iv);
26
+ let decrypted = decipher.update(encryptedText);
27
+ decrypted = Buffer.concat([decrypted, decipher.final()]);
28
+ return decrypted.toString();
29
+ }
30
+ function hash(text) {
31
+ return crypto_1.default.createHash('sha256').update(text).digest('hex');
32
+ }
package/package.json CHANGED
@@ -1,61 +1,61 @@
1
- {
2
- "name": "streamby-core",
3
- "version": "0.24.17",
4
- "description": "StreamBy middleware framework for media storage management",
5
- "main": "dist/index.js",
6
- "types": "dist/index.d.ts",
7
- "files": [
8
- "dist"
9
- ],
10
- "scripts": {
11
- "build": "tsc",
12
- "test": "vitest",
13
- "dev": "ts-node-dev --respawn --clear dev.ts",
14
- "prepublishOnly": "npm run build"
15
- },
16
- "repository": {
17
- "type": "git",
18
- "url": "https://github.com/GwerhDev/StreamBy-Package.git"
19
- },
20
- "keywords": [
21
- "streamby",
22
- "middleware",
23
- "upload",
24
- "storage",
25
- "s3",
26
- "express",
27
- "typescript"
28
- ],
29
- "author": "TerminalCore Labs",
30
- "license": "MIT",
31
- "dependencies": {
32
- "@aws-sdk/client-s3": "^3.528.0",
33
- "@aws-sdk/s3-request-presigner": "^3.787.0",
34
- "@prisma/client": "^6.12.0",
35
- "bcrypt": "^5.1.1",
36
- "dotenv": "^16.5.0",
37
- "express": "^4.0.0",
38
- "mongodb": "^6.17.0",
39
- "mongoose": "^8.13.2",
40
- "pg": "^8.16.3",
41
- "prisma": "^6.12.0",
42
- "node-fetch": "^3.0.0"
43
- },
44
- "devDependencies": {
45
- "@types/bcrypt": "^5.0.2",
46
- "@types/cors": "^2.8.18",
47
- "@types/express": "^4.17.17",
48
- "@types/mongodb": "^4.0.7",
49
- "@types/node": "^22.15.21",
50
- "@types/pg": "^8.15.4",
51
- "@types/supertest": "^6.0.3",
52
- "cors": "^2.8.5",
53
- "supertest": "^7.1.4",
54
- "ts-node-dev": "^2.0.0",
55
- "typescript": "^5.8.3",
56
- "vitest": "^3.1.1"
57
- },
58
- "peerDependencies": {
59
- "express": "^4.0.0"
60
- }
61
- }
1
+ {
2
+ "name": "streamby-core",
3
+ "version": "0.25.00",
4
+ "description": "StreamBy middleware framework for media storage management",
5
+ "main": "dist/index.js",
6
+ "types": "dist/index.d.ts",
7
+ "files": [
8
+ "dist"
9
+ ],
10
+ "scripts": {
11
+ "build": "tsc",
12
+ "test": "vitest",
13
+ "dev": "ts-node-dev --respawn --clear dev.ts",
14
+ "prepublishOnly": "npm run build"
15
+ },
16
+ "repository": {
17
+ "type": "git",
18
+ "url": "https://github.com/GwerhDev/StreamBy-Package.git"
19
+ },
20
+ "keywords": [
21
+ "streamby",
22
+ "middleware",
23
+ "upload",
24
+ "storage",
25
+ "s3",
26
+ "express",
27
+ "typescript"
28
+ ],
29
+ "author": "TerminalCore Labs",
30
+ "license": "MIT",
31
+ "dependencies": {
32
+ "@aws-sdk/client-s3": "^3.528.0",
33
+ "@aws-sdk/s3-request-presigner": "^3.787.0",
34
+ "@prisma/client": "^6.12.0",
35
+ "bcrypt": "^5.1.1",
36
+ "dotenv": "^16.5.0",
37
+ "express": "^4.0.0",
38
+ "mongodb": "^6.17.0",
39
+ "mongoose": "^8.13.2",
40
+ "pg": "^8.16.3",
41
+ "prisma": "^6.12.0",
42
+ "node-fetch": "^3.0.0"
43
+ },
44
+ "devDependencies": {
45
+ "@types/bcrypt": "^5.0.2",
46
+ "@types/cors": "^2.8.18",
47
+ "@types/express": "^4.17.17",
48
+ "@types/mongodb": "^4.0.7",
49
+ "@types/node": "^22.15.21",
50
+ "@types/pg": "^8.15.4",
51
+ "@types/supertest": "^6.0.3",
52
+ "cors": "^2.8.5",
53
+ "supertest": "^7.1.4",
54
+ "ts-node-dev": "^2.0.0",
55
+ "typescript": "^5.8.3",
56
+ "vitest": "^3.1.1"
57
+ },
58
+ "peerDependencies": {
59
+ "express": "^4.0.0"
60
+ }
61
+ }