streamby-core 0.1.0

package/README.md

@@ -0,0 +1,103 @@
+# @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)
+

package/dist/adapters/gcs.js

@@ -0,0 +1 @@
+"use strict";

package/dist/adapters/local.js

@@ -0,0 +1 @@
+"use strict";

package/dist/adapters/s3.d.ts

@@ -0,0 +1,2 @@
+import { StorageAdapter, S3Config } from '../types';
+export declare function createS3Adapter(config: S3Config): StorageAdapter;

package/dist/adapters/s3.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createS3Adapter = createS3Adapter;
+const client_s3_1 = require("@aws-sdk/client-s3");
+function createS3Adapter(config) {
+    const s3 = new client_s3_1.S3Client({
+        region: config.region,
+        credentials: {
+            accessKeyId: config.accessKeyId,
+            secretAccessKey: config.secretAccessKey,
+        },
+    });
+    return {
+        async uploadFile(req, projectId) {
+            const file = req.body.file;
+            const command = new client_s3_1.PutObjectCommand({
+                Bucket: config.bucket,
+                Key: `${projectId}/${file.name}`,
+                Body: file.buffer,
+            });
+            await s3.send(command);
+            return { success: true, key: command.input.Key };
+        },
+        async listFiles(projectId) {
+            const command = new client_s3_1.ListObjectsV2Command({
+                Bucket: config.bucket,
+                Prefix: `${projectId}/`
+            });
+            const result = await s3.send(command);
+            return result.Contents || [];
+        },
+    };
+}

package/dist/config.js

@@ -0,0 +1 @@
+"use strict";

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { createStreamByRouter } from './middleware/createRouter';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStreamByRouter = void 0;
+var createRouter_1 = require("./middleware/createRouter");
+Object.defineProperty(exports, "createStreamByRouter", { enumerable: true, get: function () { return createRouter_1.createStreamByRouter; } });

package/dist/middleware/createRouter.d.ts

@@ -0,0 +1,5 @@
+import { Router } from 'express';
+import { StreamByConfig, StorageAdapter } from '../types';
+export declare function createStreamByRouter(config: StreamByConfig & {
+    adapter?: StorageAdapter;
+}): Router;

package/dist/middleware/createRouter.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStreamByRouter = createStreamByRouter;
+const express_1 = __importDefault(require("express"));
+const s3_1 = require("../adapters/s3");
+const file_1 = require("../services/file");
+function createStreamByRouter(config) {
+    const router = express_1.default.Router();
+    const adapter = config.adapter || (() => {
+        switch (config.storageProvider.type) {
+            case 's3':
+                return (0, s3_1.createS3Adapter)(config.storageProvider.config);
+            default:
+                throw new Error('Unsupported storage type');
+        }
+    })();
+    router.get('/files', async (req, res) => {
+        try {
+            const auth = await config.authProvider(req);
+            const files = await (0, file_1.listFilesService)(adapter, req, auth.projectId);
+            res.json(files);
+        }
+        catch (err) {
+            res.status(500).json({ error: 'Failed to list files', details: err });
+        }
+    });
+    router.post('/upload', async (req, res) => {
+        try {
+            const auth = await config.authProvider(req);
+            const result = await (0, file_1.uploadFileService)(adapter, req, auth.projectId);
+            res.json(result);
+        }
+        catch (err) {
+            res.status(500).json({ error: 'Failed to upload file', details: err });
+        }
+    });
+    return router;
+}

package/dist/services/auth.d.ts

@@ -0,0 +1,4 @@
+import { Request } from 'express';
+import { StreamByConfig, AuthContext } from '../types';
+export declare function resolveAuth(config: StreamByConfig, req: Request): Promise<AuthContext>;
+export declare function checkRole(auth: AuthContext, required: 'viewer' | 'editor' | 'admin'): void;

package/dist/services/auth.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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) {
+        throw new Error('Invalid or missing authentication context');
+    }
+    return auth;
+}
+function checkRole(auth, required) {
+    const roles = ['viewer', 'editor', 'admin'];
+    const userIdx = roles.indexOf(auth.role);
+    const requiredIdx = roles.indexOf(required);
+    if (userIdx < requiredIdx) {
+        throw new Error(`Insufficient role: requires ${required}, found ${auth.role}`);
+    }
+}

package/dist/services/file.d.ts

@@ -0,0 +1,4 @@
+import { StorageAdapter } from '../types';
+import { Request } from 'express';
+export declare function listFilesService(adapter: StorageAdapter, req: Request, projectId: string): Promise<any[]>;
+export declare function uploadFileService(adapter: StorageAdapter, req: Request, projectId: string): Promise<any>;

package/dist/services/file.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listFilesService = listFilesService;
+exports.uploadFileService = uploadFileService;
+async function listFilesService(adapter, req, projectId) {
+    return adapter.listFiles(projectId);
+}
+async function uploadFileService(adapter, req, projectId) {
+    return adapter.uploadFile(req, projectId);
+}

package/dist/types/index.d.ts

@@ -0,0 +1,29 @@
+import { Request } from 'express';
+export interface S3Config {
+    bucket: string;
+    region: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+}
+export type StorageProviderType = 's3';
+export interface StorageAdapter {
+    uploadFile(req: Request, projectId: string): Promise<any>;
+    listFiles(projectId: string): Promise<any[]>;
+}
+export interface StreamByConfig {
+    storageProvider: {
+        type: StorageProviderType;
+        config: S3Config;
+    };
+    authProvider: (req: Request) => Promise<{
+        userId: string;
+        projectId: string;
+        role: 'viewer' | 'editor' | 'admin';
+    }>;
+}
+export interface AuthContext {
+    userId: string;
+    projectId: string;
+    role: 'viewer' | 'editor' | 'admin';
+}
+export type AuthProvider = (req: Request) => Promise<AuthContext>;

package/dist/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +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"
+  }
+}