streamby-core 0.1.0 → 0.3.0

package/README.md

@@ -1,103 +1,114 @@
-# @streamby/core
-
-Middleware framework for building storage-agnostic media APIs.  
-Part of the [StreamBy](https://streamby.nhexa.cl) ecosystem by TerminalCore Labs.
-
----
-
-## 🚀 What is it?
-
-`@streamby/core` is a plug-and-play middleware for Express (or compatible frameworks) that enables file uploads, listings and project-based access over services like:
-
-- ✅ AWS S3
-- ✅ Google Cloud Storage (soon)
-- ✅ Cloudflare R2 (soon)
-- ✅ Local/Personal servers (soon)
-
-It's designed to be installed inside your existing API as a library — **no need to run a separate backend**.
-
----
-
-## 📦 Installation
-
-```bash
-npm install @streamby/core
-```
-
----
-
-## 🧱 Basic usage
-
-```ts
-import express from 'express';
-import { createStreamByRouter } from '@streamby/core';
-
-const app = express();
-
-app.use('/streamby', createStreamByRouter({
-  storageProvider: {
-    type: 's3',
-    config: {
-      bucket: 'your-bucket-name',
-      region: 'your-region',
-      accessKeyId: 'YOUR_AWS_KEY',
-      secretAccessKey: 'YOUR_AWS_SECRET'
-    }
-  },
-  authProvider: async (req) => {
-    // validate token, session, etc.
-    return {
-      userId: 'demo',
-      projectId: 'demo-project',
-      role: 'admin',
-    };
-  }
-}));
-
-app.listen(3000);
-```
-
----
-
-## 🧪 Testing
-
-```bash
-npm run test
-```
-
-Unit tests use [Vitest](https://vitest.dev) and [Supertest](https://www.npmjs.com/package/supertest).
-
----
-
-## 📁 Features
-
-- 🧹 Modular adapters per storage provider
-- 🔐 Auth/permission integration per request
-- 📂 File listing, uploading and deletion
-- 🧰 Built-in testability with mock adapters
-- ⚡ Easy to extend and compose
-
----
-
-## 🚣 Roadmap
-
-- [ ] Support for Google Cloud Storage
-- [ ] CLI tool for uploading files
-- [ ] Role-based access control middleware
-- [ ] Plugin system for extended routes
-
----
-
-## 🧑‍💻 Maintained by
-
-**TerminalCore Labs** – part of [Nhexa Entertainment](https://nhexa.cl)  
-Developed as open-source infrastructure for creative and media-oriented apps.
-
-Visit us [here](https://terminalcore.cl)
-
----
-
-## 📟 License
-
-[MIT](./LICENSE)
-
+# @streamby/core
+
+Middleware framework for building storage-agnostic media APIs.  
+Part of the [StreamBy](https://streamby.nhexa.cl) ecosystem by TerminalCore Labs.
+
+---
+
+## 🚀 What is it?
+
+`@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:
+
+- ✅ AWS S3
+- ✅ Google Cloud Storage (soon)
+- ✅ Cloudflare R2 (soon)
+- ✅ Local/Personal servers (soon)
+
+It's designed to be installed inside your existing API as a library — **no need to run a separate backend**.
+
+---
+
+## 📦 Installation
+
+```bash
+npm install @streamby/core
+```
+
+---
+
+## 🧱 Basic usage
+
+```ts
+import express from 'express';
+import { createStreamByRouter } from '@streamby/core';
+
+const app = express();
+
+app.use('/streamby', createStreamByRouter({
+  storageProvider: {
+    type: 's3',
+    config: {
+      bucket: 'your-bucket-name',
+      region: 'your-region',
+      accessKeyId: 'YOUR_AWS_KEY',
+      secretAccessKey: 'YOUR_AWS_SECRET'
+    }
+  },
+  authProvider: async (req) => {
+    // extract token/cookie and validate
+    return {
+      userId: 'demo',
+      projects: ['demo-project'],
+      role: 'admin',
+    };
+  },
+  projectProvider: async (projectId) => {
+    // fetch project from your DB
+    return {
+      id: projectId,
+      name: 'Demo Project',
+      description: 'Demo for StreamBy integration',
+      rootFolders: [],
+      settings: { allowUpload: true }
+    };
+  }
+}));
+
+app.listen(3000);
+```
+
+---
+
+## 🧪 Testing
+
+```bash
+npm run test
+```
+
+Unit tests use [Vitest](https://vitest.dev) and [Supertest](https://www.npmjs.com/package/supertest).
+
+---
+
+## 📁 Features
+
+- 📂 Multi-project access control
+- 🔐 Project-aware file uploads & listings
+- 🧹 Modular adapters per storage provider
+- 🧰 Built-in testability with mock auth & storage
+- ✨ Simple to extend for custom business logic
+
+---
+
+## 🚣 Roadmap
+
+- [ ] Support for Google Cloud Storage
+- [ ] CLI tool for uploading files
+- [ ] Role-based access control middleware
+- [ ] Plugin system for extended routes
+- [ ] Streaming support (HLS, audio, etc.)
+
+---
+
+## 🧑‍💻 Maintained by
+
+**TerminalCore Labs** – part of [Nhexa Entertainment](https://nhexa.cl)  
+Developed as open-source infrastructure for creative and media-oriented apps.
+
+Visit us [here](https://terminalcore.cl)
+
+---
+
+## 📟 License
+
+[MIT](./LICENSE)
+

package/dist/adapters/s3.js

@@ -12,19 +12,23 @@ function createS3Adapter(config) {
     });
     return {
         async uploadFile(req, projectId) {
-            const file = req.body.file;
+            const file = req.body?.file;
+            if (!file || !file.name || !file.buffer) {
+                throw new Error('Invalid file upload: missing name or buffer');
+            }
+            const key = `${projectId}/${file.name}`;
             const command = new client_s3_1.PutObjectCommand({
                 Bucket: config.bucket,
-                Key: `${projectId}/${file.name}`,
+                Key: key,
                 Body: file.buffer,
             });
             await s3.send(command);
-            return { success: true, key: command.input.Key };
+            return { success: true, key };
         },
         async listFiles(projectId) {
             const command = new client_s3_1.ListObjectsV2Command({
                 Bucket: config.bucket,
-                Prefix: `${projectId}/`
+                Prefix: `${projectId}/`,
             });
             const result = await s3.send(command);
             return result.Contents || [];

package/dist/middleware/createRouter.js

@@ -17,10 +17,23 @@ function createStreamByRouter(config) {
                 throw new Error('Unsupported storage type');
         }
     })();
+    router.get('/auth', async (req, res) => {
+        try {
+            const auth = await config.authProvider(req);
+            res.status(200).json({ logged: true, ...auth });
+        }
+        catch (err) {
+            res.status(401).json({ logged: false });
+        }
+    });
     router.get('/files', async (req, res) => {
         try {
             const auth = await config.authProvider(req);
-            const files = await (0, file_1.listFilesService)(adapter, req, auth.projectId);
+            const projectId = (req.query.projectId || req.headers['x-project-id']);
+            if (!projectId || !auth.projects.includes(projectId)) {
+                return res.status(403).json({ error: 'Unauthorized or missing projectId' });
+            }
+            const files = await (0, file_1.listFilesService)(adapter, req, projectId);
             res.json(files);
         }
         catch (err) {
@@ -30,12 +43,30 @@ function createStreamByRouter(config) {
     router.post('/upload', async (req, res) => {
         try {
             const auth = await config.authProvider(req);
-            const result = await (0, file_1.uploadFileService)(adapter, req, auth.projectId);
+            const projectId = (req.query.projectId || req.headers['x-project-id']);
+            if (!projectId || !auth.projects.includes(projectId)) {
+                return res.status(403).json({ error: 'Unauthorized or missing projectId' });
+            }
+            const result = await (0, file_1.uploadFileService)(adapter, req, projectId);
             res.json(result);
         }
         catch (err) {
             res.status(500).json({ error: 'Failed to upload file', details: err });
         }
     });
+    router.get('/projects/:id', async (req, res) => {
+        try {
+            const auth = await config.authProvider(req);
+            const projectId = req.params.id;
+            if (!projectId || !auth.projects.includes(projectId)) {
+                return res.status(403).json({ error: 'Unauthorized project access' });
+            }
+            const project = await config.projectProvider(projectId);
+            res.json({ project });
+        }
+        catch (err) {
+            res.status(404).json({ error: 'Project not found', details: err });
+        }
+    });
     return router;
 }

package/dist/services/auth.js

@@ -4,7 +4,11 @@ exports.resolveAuth = resolveAuth;
 exports.checkRole = checkRole;
 async function resolveAuth(config, req) {
     const auth = await config.authProvider(req);
-    if (!auth || !auth.userId || !auth.projectId || !auth.role) {
+    if (!auth ||
+        !auth.userId ||
+        !Array.isArray(auth.projects) ||
+        auth.projects.length === 0 ||
+        !auth.role) {
         throw new Error('Invalid or missing authentication context');
     }
     return auth;

package/dist/types/index.d.ts

@@ -10,20 +10,33 @@ export interface StorageAdapter {
     uploadFile(req: Request, projectId: string): Promise<any>;
     listFiles(projectId: string): Promise<any[]>;
 }
+export interface ProjectInfo {
+    id: string;
+    name: string;
+    description?: string;
+    rootFolders?: FolderNode[];
+    settings?: {
+        allowUpload?: boolean;
+        allowSharing?: boolean;
+    };
+}
+export interface FolderNode {
+    id: string;
+    name: string;
+    children?: FolderNode[];
+}
 export interface StreamByConfig {
     storageProvider: {
         type: StorageProviderType;
         config: S3Config;
     };
-    authProvider: (req: Request) => Promise<{
-        userId: string;
-        projectId: string;
-        role: 'viewer' | 'editor' | 'admin';
-    }>;
+    authProvider: AuthProvider;
+    projectProvider: ProjectProvider;
 }
 export interface AuthContext {
     userId: string;
-    projectId: string;
+    projects: string[];
     role: 'viewer' | 'editor' | 'admin';
 }
 export type AuthProvider = (req: Request) => Promise<AuthContext>;
+export type ProjectProvider = (projectId: string) => Promise<ProjectInfo>;

package/package.json

@@ -1,45 +1,45 @@
-{
-  "name": "streamby-core",
-  "version": "0.1.0",
-  "description": "StreamBy middleware framework for media storage management",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "test": "vitest",
-    "dev": "tsc --watch",
-    "prepublishOnly": "npm run build"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/GwerhDev/StreamBy-Package.git"
-  },
-  "keywords": [
-    "streamby",
-    "middleware",
-    "upload",
-    "storage",
-    "s3",
-    "express",
-    "typescript"
-  ],
-  "author": "TerminalCore Labs",
-  "license": "MIT",
-  "dependencies": {
-    "@aws-sdk/client-s3": "^3.528.0",
-    "express": "^4.0.0"
-  },
-  "devDependencies": {
-    "@types/express": "^4.17.17",
-    "@types/supertest": "^6.0.3",
-    "supertest": "^7.1.0",
-    "typescript": "^5.8.3",
-    "vitest": "^3.1.1"
-  },
-  "peerDependencies": {
-    "express": "^4.0.0"
-  }
-}
+{
+  "name": "streamby-core",
+  "version": "0.3.0",
+  "description": "StreamBy middleware framework for media storage management",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GwerhDev/StreamBy-Package.git"
+  },
+  "keywords": [
+    "streamby",
+    "middleware",
+    "upload",
+    "storage",
+    "s3",
+    "express",
+    "typescript"
+  ],
+  "author": "TerminalCore Labs",
+  "license": "MIT",
+  "dependencies": {
+    "@aws-sdk/client-s3": "^3.528.0",
+    "express": "^4.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.17",
+    "@types/supertest": "^6.0.3",
+    "supertest": "^7.1.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.1"
+  },
+  "peerDependencies": {
+    "express": "^4.0.0"
+  }
+}