@objectstack/service-storage 4.0.3 → 4.0.5

package/src/local-storage-adapter.ts

@@ -1,100 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import { promises as fs } from 'node:fs';
-import { join, dirname } from 'node:path';
-import type { IStorageService, StorageUploadOptions, StorageFileInfo } from '@objectstack/spec/contracts';
-
-/**
- * Configuration options for LocalStorageAdapter.
- */
-export interface LocalStorageAdapterOptions {
-  /** Root directory for file storage */
-  rootDir: string;
-}
-
-/**
- * Local filesystem storage adapter implementing IStorageService.
- *
- * Stores files on the local disk under a configurable root directory.
- * Suitable for development, testing, and single-server deployments.
- */
-export class LocalStorageAdapter implements IStorageService {
-  private readonly rootDir: string;
-
-  constructor(options: LocalStorageAdapterOptions) {
-    this.rootDir = options.rootDir;
-  }
-
-  private resolvePath(key: string): string {
-    return join(this.rootDir, key);
-  }
-
-  async upload(key: string, data: Buffer | ReadableStream, _options?: StorageUploadOptions): Promise<void> {
-    const filePath = this.resolvePath(key);
-    await fs.mkdir(dirname(filePath), { recursive: true });
-
-    if (data instanceof Buffer) {
-      await fs.writeFile(filePath, data);
-    } else {
-      // Convert ReadableStream to Buffer
-      const chunks: Uint8Array[] = [];
-      const reader = (data as ReadableStream).getReader();
-      let done = false;
-      while (!done) {
-        const result = await reader.read();
-        done = result.done;
-        if (result.value) chunks.push(result.value);
-      }
-      await fs.writeFile(filePath, Buffer.concat(chunks));
-    }
-  }
-
-  async download(key: string): Promise<Buffer> {
-    const filePath = this.resolvePath(key);
-    return fs.readFile(filePath);
-  }
-
-  async delete(key: string): Promise<void> {
-    const filePath = this.resolvePath(key);
-    await fs.unlink(filePath);
-  }
-
-  async exists(key: string): Promise<boolean> {
-    try {
-      await fs.access(this.resolvePath(key));
-      return true;
-    } catch {
-      return false;
-    }
-  }
-
-  async getInfo(key: string): Promise<StorageFileInfo> {
-    const filePath = this.resolvePath(key);
-    const stat = await fs.stat(filePath);
-    return {
-      key,
-      size: stat.size,
-      lastModified: stat.mtime,
-    };
-  }
-
-  async list(prefix: string): Promise<StorageFileInfo[]> {
-    const dirPath = this.resolvePath(prefix);
-    try {
-      const entries = await fs.readdir(dirPath);
-      const results: StorageFileInfo[] = [];
-      for (const entry of entries) {
-        const fullKey = prefix ? `${prefix}/${entry}` : entry;
-        try {
-          const info = await this.getInfo(fullKey);
-          results.push(info);
-        } catch {
-          // Skip entries that can't be stat'd
-        }
-      }
-      return results;
-    } catch {
-      return [];
-    }
-  }
-}

package/src/s3-storage-adapter.ts

@@ -1,88 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import type { IStorageService, StorageUploadOptions, StorageFileInfo } from '@objectstack/spec/contracts';
-
-/**
- * Configuration for the S3 storage adapter.
- */
-export interface S3StorageAdapterOptions {
-  /** S3 bucket name */
-  bucket: string;
-  /** AWS region (e.g. 'us-east-1') */
-  region: string;
-  /** Optional endpoint URL for S3-compatible services (MinIO, etc.) */
-  endpoint?: string;
-  /** AWS access key ID */
-  accessKeyId?: string;
-  /** AWS secret access key */
-  secretAccessKey?: string;
-}
-
-/**
- * S3 storage adapter skeleton implementing IStorageService.
- *
- * This is a placeholder for future AWS S3 integration.
- * Concrete implementation will use the `@aws-sdk/client-s3` package.
- *
- * @example
- * ```ts
- * const storage = new S3StorageAdapter({
- *   bucket: 'my-bucket',
- *   region: 'us-east-1',
- * });
- * await storage.upload('path/to/file.txt', buffer);
- * ```
- */
-export class S3StorageAdapter implements IStorageService {
-  private readonly bucket: string;
-  private readonly region: string;
-
-  constructor(options: S3StorageAdapterOptions) {
-    this.bucket = options.bucket;
-    this.region = options.region;
-  }
-
-  async upload(_key: string, _data: Buffer | ReadableStream, _options?: StorageUploadOptions): Promise<void> {
-    throw new Error(`S3StorageAdapter not yet implemented (bucket: ${this.bucket}, region: ${this.region})`);
-  }
-
-  async download(_key: string): Promise<Buffer> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async delete(_key: string): Promise<void> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async exists(_key: string): Promise<boolean> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async getInfo(_key: string): Promise<StorageFileInfo> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async list(_prefix: string): Promise<StorageFileInfo[]> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async getSignedUrl(_key: string, _expiresIn: number): Promise<string> {
-    throw new Error('S3StorageAdapter not yet implemented');
-  }
-
-  async initiateChunkedUpload(_key: string, _options?: StorageUploadOptions): Promise<string> {
-    throw new Error('S3StorageAdapter.initiateChunkedUpload not yet implemented');
-  }
-
-  async uploadChunk(_uploadId: string, _partNumber: number, _data: Buffer): Promise<string> {
-    throw new Error('S3StorageAdapter.uploadChunk not yet implemented');
-  }
-
-  async completeChunkedUpload(_uploadId: string, _parts: Array<{ partNumber: number; eTag: string }>): Promise<string> {
-    throw new Error('S3StorageAdapter.completeChunkedUpload not yet implemented');
-  }
-
-  async abortChunkedUpload(_uploadId: string): Promise<void> {
-    throw new Error('S3StorageAdapter.abortChunkedUpload not yet implemented');
-  }
-}

package/src/storage-service-plugin.ts

@@ -1,66 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-import type { Plugin, PluginContext } from '@objectstack/core';
-import { LocalStorageAdapter } from './local-storage-adapter.js';
-import type { LocalStorageAdapterOptions } from './local-storage-adapter.js';
-
-/**
- * Configuration options for the StorageServicePlugin.
- */
-export interface StorageServicePluginOptions {
-  /** Storage adapter type (default: 'local') */
-  adapter?: 'local' | 's3';
-  /** Options for the local storage adapter */
-  local?: LocalStorageAdapterOptions;
-  /** S3 configuration (used when adapter is 's3') */
-  s3?: { bucket: string; region: string; endpoint?: string };
-}
-
-/**
- * StorageServicePlugin — Production IStorageService implementation.
- *
- * Registers a file storage service with the kernel during the init phase.
- * Supports local filesystem and S3 adapters.
- *
- * @example
- * ```ts
- * import { ObjectKernel } from '@objectstack/core';
- * import { StorageServicePlugin } from '@objectstack/service-storage';
- *
- * const kernel = new ObjectKernel();
- * kernel.use(new StorageServicePlugin({
- *   adapter: 'local',
- *   local: { rootDir: './uploads' },
- * }));
- * await kernel.bootstrap();
- *
- * const storage = kernel.getService('file-storage');
- * await storage.upload('file.txt', Buffer.from('hello'));
- * ```
- */
-export class StorageServicePlugin implements Plugin {
-  name = 'com.objectstack.service.storage';
-  version = '1.0.0';
-  type = 'standard';
-
-  private readonly options: StorageServicePluginOptions;
-
-  constructor(options: StorageServicePluginOptions = {}) {
-    this.options = { adapter: 'local', ...options };
-  }
-
-  async init(ctx: PluginContext): Promise<void> {
-    const adapter = this.options.adapter;
-    if (adapter === 's3') {
-      throw new Error(
-        'S3 storage adapter is not yet implemented. ' +
-        'Use adapter: "local" or provide a custom IStorageService via ctx.registerService("file-storage", impl).'
-      );
-    }
-
-    const rootDir = this.options.local?.rootDir ?? './storage';
-    const storage = new LocalStorageAdapter({ rootDir });
-    ctx.registerService('file-storage', storage);
-    ctx.logger.info(`StorageServicePlugin: registered local storage adapter (root: ${rootDir})`);
-  }
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "extends": "../../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src",
-    "types": [
-      "node"
-    ]
-  },
-  "include": [
-    "src"
-  ],
-  "exclude": [
-    "node_modules",
-    "dist"
-  ]
-}