@gravito/nebula 1.0.0-alpha.2

package/README.md

@@ -0,0 +1,47 @@
+# @gravito/nebula
+
+> The Standard Storage Orbit for Galaxy Architecture.
+
+Provides an abstraction layer for file storage, with a built-in Local Disk provider.
+
+## 📦 Installation
+
+```bash
+bun add @gravito/nebula
+```
+
+## 🚀 Usage
+
+```typescript
+import { PlanetCore } from 'gravito-core';
+import orbitStorage from '@gravito/nebula';
+
+const core = new PlanetCore();
+
+// Initialize Storage Orbit (Local)
+const storage = orbitStorage(core, {
+  local: {
+    root: './uploads',
+    baseUrl: '/uploads'
+  },
+  exposeAs: 'storage' // Access via c.get('storage')
+});
+
+// Use in routes
+core.app.post('/upload', async (c) => {
+  const body = await c.req.parseBody();
+  const file = body['file'];
+  
+  if (file instanceof File) {
+    await storage.put(file.name, file);
+    return c.json({ url: storage.getUrl(file.name) });
+  }
+  return c.text('No file uploaded', 400);
+});
+```
+
+## 🪝 Hooks
+
+- `storage:init` - Fired when initialized.
+- `storage:upload` - (Filter) Modify data before upload.
+- `storage:uploaded` - (Action) Triggered after successful upload.

package/dist/index.cjs

@@ -0,0 +1,140 @@
+var __create = Object.create;
+var __getProtoOf = Object.getPrototypeOf;
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __toESM = (mod, isNodeMode, target) => {
+  target = mod != null ? __create(__getProtoOf(mod)) : {};
+  const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
+  for (let key of __getOwnPropNames(mod))
+    if (!__hasOwnProp.call(to, key))
+      __defProp(to, key, {
+        get: () => mod[key],
+        enumerable: true
+      });
+  return to;
+};
+var __moduleCache = /* @__PURE__ */ new WeakMap;
+var __toCommonJS = (from) => {
+  var entry = __moduleCache.get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function")
+    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    }));
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: (newValue) => all[name] = () => newValue
+    });
+};
+
+// src/index.ts
+var exports_src = {};
+__export(exports_src, {
+  default: () => orbitStorage,
+  OrbitStorage: () => OrbitStorage,
+  LocalStorageProvider: () => LocalStorageProvider
+});
+module.exports = __toCommonJS(exports_src);
+var import_promises = require("node:fs/promises");
+var import_node_path = require("node:path");
+
+class LocalStorageProvider {
+  rootDir;
+  baseUrl;
+  constructor(rootDir, baseUrl = "/storage") {
+    this.rootDir = rootDir;
+    this.baseUrl = baseUrl;
+  }
+  async put(key, data) {
+    const path = import_node_path.join(this.rootDir, key);
+    const dir = path.substring(0, path.lastIndexOf("/"));
+    if (dir && dir !== this.rootDir) {
+      await import_promises.mkdir(dir, { recursive: true });
+    }
+    await Bun.write(path, data);
+  }
+  async get(key) {
+    const file = Bun.file(import_node_path.join(this.rootDir, key));
+    if (!await file.exists()) {
+      return null;
+    }
+    return file;
+  }
+  async delete(key) {
+    const fs = await import("node:fs/promises");
+    try {
+      await fs.unlink(import_node_path.join(this.rootDir, key));
+    } catch {}
+  }
+  getUrl(key) {
+    return `${this.baseUrl}/${key}`;
+  }
+}
+
+class OrbitStorage {
+  options;
+  constructor(options) {
+    this.options = options;
+  }
+  install(core) {
+    const config = this.options || core.config.get("storage");
+    if (!config) {
+      throw new Error('[OrbitStorage] Configuration is required. Please provide options or set "storage" in core config.');
+    }
+    const { exposeAs = "storage" } = config;
+    const logger = core.logger;
+    logger.info(`[OrbitStorage] Initializing Storage (Exposed as: ${exposeAs})`);
+    let provider = config.provider;
+    if (!provider && config.local) {
+      logger.info(`[OrbitStorage] Using LocalStorageProvider at ${config.local.root}`);
+      provider = new LocalStorageProvider(config.local.root, config.local.baseUrl);
+    }
+    if (!provider) {
+      throw new Error("[OrbitStorage] No provider configured. Please provide a provider instance or local configuration.");
+    }
+    const storageService = {
+      ...provider,
+      put: async (key, data) => {
+        const finalData = await core.hooks.applyFilters("storage:upload", data, { key });
+        await provider?.put(key, finalData);
+        await core.hooks.doAction("storage:uploaded", { key });
+      }
+    };
+    core.adapter.use("*", async (c, next) => {
+      c.set(exposeAs, storageService);
+      await next();
+    });
+    core.hooks.doAction("storage:init", storageService);
+  }
+}
+function orbitStorage(core, options) {
+  const orbit = new OrbitStorage(options);
+  orbit.install(core);
+  let provider = options.provider;
+  if (!provider && options.local) {
+    provider = new LocalStorageProvider(options.local.root, options.local.baseUrl);
+  }
+  if (!provider) {
+    throw new Error("[OrbitStorage] No provider configured.");
+  }
+  return {
+    ...provider,
+    put: async (key, data) => {
+      const finalData = await core.hooks.applyFilters("storage:upload", data, { key });
+      await provider?.put(key, finalData);
+      await core.hooks.doAction("storage:uploaded", { key });
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,116 @@
+import { createRequire } from "node:module";
+var __create = Object.create;
+var __getProtoOf = Object.getPrototypeOf;
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __toESM = (mod, isNodeMode, target) => {
+  target = mod != null ? __create(__getProtoOf(mod)) : {};
+  const to = isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target;
+  for (let key of __getOwnPropNames(mod))
+    if (!__hasOwnProp.call(to, key))
+      __defProp(to, key, {
+        get: () => mod[key],
+        enumerable: true
+      });
+  return to;
+};
+var __require = /* @__PURE__ */ createRequire(import.meta.url);
+
+// src/index.ts
+import { mkdir } from "node:fs/promises";
+import { join } from "node:path";
+
+class LocalStorageProvider {
+  rootDir;
+  baseUrl;
+  constructor(rootDir, baseUrl = "/storage") {
+    this.rootDir = rootDir;
+    this.baseUrl = baseUrl;
+  }
+  async put(key, data) {
+    const path = join(this.rootDir, key);
+    const dir = path.substring(0, path.lastIndexOf("/"));
+    if (dir && dir !== this.rootDir) {
+      await mkdir(dir, { recursive: true });
+    }
+    await Bun.write(path, data);
+  }
+  async get(key) {
+    const file = Bun.file(join(this.rootDir, key));
+    if (!await file.exists()) {
+      return null;
+    }
+    return file;
+  }
+  async delete(key) {
+    const fs = await import("node:fs/promises");
+    try {
+      await fs.unlink(join(this.rootDir, key));
+    } catch {}
+  }
+  getUrl(key) {
+    return `${this.baseUrl}/${key}`;
+  }
+}
+
+class OrbitStorage {
+  options;
+  constructor(options) {
+    this.options = options;
+  }
+  install(core) {
+    const config = this.options || core.config.get("storage");
+    if (!config) {
+      throw new Error('[OrbitStorage] Configuration is required. Please provide options or set "storage" in core config.');
+    }
+    const { exposeAs = "storage" } = config;
+    const logger = core.logger;
+    logger.info(`[OrbitStorage] Initializing Storage (Exposed as: ${exposeAs})`);
+    let provider = config.provider;
+    if (!provider && config.local) {
+      logger.info(`[OrbitStorage] Using LocalStorageProvider at ${config.local.root}`);
+      provider = new LocalStorageProvider(config.local.root, config.local.baseUrl);
+    }
+    if (!provider) {
+      throw new Error("[OrbitStorage] No provider configured. Please provide a provider instance or local configuration.");
+    }
+    const storageService = {
+      ...provider,
+      put: async (key, data) => {
+        const finalData = await core.hooks.applyFilters("storage:upload", data, { key });
+        await provider?.put(key, finalData);
+        await core.hooks.doAction("storage:uploaded", { key });
+      }
+    };
+    core.adapter.use("*", async (c, next) => {
+      c.set(exposeAs, storageService);
+      await next();
+    });
+    core.hooks.doAction("storage:init", storageService);
+  }
+}
+function orbitStorage(core, options) {
+  const orbit = new OrbitStorage(options);
+  orbit.install(core);
+  let provider = options.provider;
+  if (!provider && options.local) {
+    provider = new LocalStorageProvider(options.local.root, options.local.baseUrl);
+  }
+  if (!provider) {
+    throw new Error("[OrbitStorage] No provider configured.");
+  }
+  return {
+    ...provider,
+    put: async (key, data) => {
+      const finalData = await core.hooks.applyFilters("storage:upload", data, { key });
+      await provider?.put(key, finalData);
+      await core.hooks.doAction("storage:uploaded", { key });
+    }
+  };
+}
+export {
+  orbitStorage as default,
+  OrbitStorage,
+  LocalStorageProvider
+};

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@gravito/nebula",
+  "version": "1.0.0-alpha.2",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Standard Storage Orbit for Galaxy Architecture",
+  "module": "./dist/index.mjs",
+  "main": "./dist/index.cjs",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "bun run build.ts",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "gravito",
+    "orbit",
+    "storage",
+    "upload"
+  ],
+  "author": "Carl Lee <carllee0520@gmail.com>",
+  "license": "MIT",
+  "peerDependencies": {
+    "gravito-core": "1.0.0-beta.2"
+  },
+  "devDependencies": {
+    "gravito-core": "1.0.0-beta.2",
+    "hono": "^4.11.1",
+    "bun-types": "latest",
+    "typescript": "^5.9.3"
+  },
+  "homepage": "https://github.com/gravito-framework/gravito#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gravito-framework/gravito.git",
+    "directory": "packages/nebula"
+  }
+}