@onlineapps/conn-base-storage 1.0.0 → 1.0.1

package/README.md

@@ -1,33 +1,33 @@
-# Connector Storage - Sdílený přístup k MinIO
+# @onlineapps/conn-base-storage
 
-Jednotná knihovna pro všechny služby pro práci s api_services_storage (MinIO).
+Unified MinIO client for all OA Drive services. Provides direct S3-compatible access to object storage with fingerprint-based immutable content handling.
 
-## Proč přímý přístup (ne MQ wrapper)?
+## Why Direct Access (Not MQ Wrapper)?
 
-1. **Performance** - MinIO je optimalizované pro přímý přístup
-2. **Standard** - S3 API je průmyslový standard
-3. **Efektivita** - Streaming velkých souborů
-4. **Best Practice** - Object storage se vždy používá přímo
+1. **Performance** - MinIO is optimized for direct streaming
+2. **Standard** - S3 API is industry standard
+3. **Efficiency** - Direct streaming for large files
+4. **Best Practice** - Object storage always accessed directly
 
-## Instalace
+## Installation
 
 ```bash
-npm install @shared/connector-storage
+npm install @onlineapps/conn-base-storage
 ```
 
-## Použití
+## Quick Start
 
 ```javascript
-const StorageConnector = require('@shared/connector-storage');
+const StorageConnector = require('@onlineapps/conn-base-storage');
 
 const storage = new StorageConnector({
   endpoint: process.env.MINIO_HOST || 'api_services_storage',
   port: 9000,
-  accessKey: process.env.MINIO_ACCESS_KEY || 'minioadmin',
-  secretKey: process.env.MINIO_SECRET_KEY || 'minioadmin'
+  accessKey: process.env.MINIO_ACCESS_KEY,
+  secretKey: process.env.MINIO_SECRET_KEY
 });
 
-// Upload s fingerprintem
+// Upload with fingerprint
 const result = await storage.uploadWithFingerprint(
   'registry',
   content,
@@ -35,14 +35,14 @@ const result = await storage.uploadWithFingerprint(
 );
 // Returns: { path: 'specs/invoicing/abc123.json', fingerprint: 'abc123', size: 1234 }
 
-// Download s ověřením
+// Download with verification
 const content = await storage.downloadWithVerification(
   'registry',
   'specs/invoicing/abc123.json',
   'abc123'  // expected fingerprint
 );
 
-// Get pre-signed URL pro externí přístup
+// Get pre-signed URL for external access
 const url = await storage.getPresignedUrl(
   'registry',
   'specs/invoicing/abc123.json',
@@ -50,145 +50,30 @@ const url = await storage.getPresignedUrl(
 );
 ```
 
-## API
+## Core Methods
 
-### Core Methods
+### `uploadWithFingerprint(bucket, content, basePath)`
+Uploads content with automatic fingerprint in filename.
 
-#### `uploadWithFingerprint(bucket, content, basePath)`
-Nahraje obsah a automaticky přidá fingerprint do názvu souboru.
+### `downloadWithVerification(bucket, path, expectedFingerprint)`
+Downloads file and verifies fingerprint.
 
-#### `downloadWithVerification(bucket, path, expectedFingerprint)`
-Stáhne soubor a ověří jeho fingerprint.
+### `exists(bucket, path)`
+Checks if file exists.
 
-#### `exists(bucket, path)`
-Zkontroluje existenci souboru.
+### `getPresignedUrl(bucket, path, expiry)`
+Creates temporary URL for external access.
 
-#### `getPresignedUrl(bucket, path, expiry)`
-Vytvoří dočasnou URL pro externí přístup.
+### `calculateFingerprint(content)`
+Calculates SHA256 fingerprint.
 
-### Helper Methods
+### `listByPrefix(bucket, prefix)`
+Lists all objects with given prefix.
 
-#### `calculateFingerprint(content)`
-Spočítá SHA256 fingerprint obsahu.
-
-#### `listByPrefix(bucket, prefix)`
-Vypíše všechny objekty s daným prefixem.
-
-## Implementace
-
-```javascript
-// connector-storage/index.js
-const Minio = require('minio');
-const crypto = require('crypto');
-
-class StorageConnector {
-  constructor(config = {}) {
-    this.client = new Minio.Client({
-      endPoint: config.endpoint || 'api_services_storage',
-      port: config.port || 9000,
-      useSSL: config.useSSL || false,
-      accessKey: config.accessKey || 'minioadmin',
-      secretKey: config.secretKey || 'minioadmin'
-    });
-
-    // Ensure buckets exist
-    this.initBuckets();
-  }
-
-  async initBuckets() {
-    const buckets = ['registry', 'workflow', 'services'];
-    for (const bucket of buckets) {
-      const exists = await this.client.bucketExists(bucket);
-      if (!exists) {
-        await this.client.makeBucket(bucket);
-      }
-    }
-  }
-
-  calculateFingerprint(content) {
-    return crypto
-      .createHash('sha256')
-      .update(content)
-      .digest('hex');
-  }
-
-  async uploadWithFingerprint(bucket, content, basePath) {
-    const fingerprint = this.calculateFingerprint(content);
-    const path = `${basePath}/${fingerprint}.json`;
-
-    await this.client.putObject(
-      bucket,
-      path,
-      content,
-      content.length,
-      {
-        'Content-Type': 'application/json',
-        'X-Fingerprint': fingerprint
-      }
-    );
-
-    return {
-      path,
-      fingerprint,
-      size: content.length,
-      bucket
-    };
-  }
-
-  async downloadWithVerification(bucket, path, expectedFingerprint) {
-    const stream = await this.client.getObject(bucket, path);
-    const chunks = [];
-
-    for await (const chunk of stream) {
-      chunks.push(chunk);
-    }
-
-    const content = Buffer.concat(chunks).toString();
-    const actualFingerprint = this.calculateFingerprint(content);
-
-    if (expectedFingerprint && actualFingerprint !== expectedFingerprint) {
-      throw new Error(`Fingerprint mismatch! Expected: ${expectedFingerprint}, Got: ${actualFingerprint}`);
-    }
-
-    return content;
-  }
-
-  async exists(bucket, path) {
-    try {
-      await this.client.statObject(bucket, path);
-      return true;
-    } catch (err) {
-      if (err.code === 'NotFound') {
-        return false;
-      }
-      throw err;
-    }
-  }
-
-  async getPresignedUrl(bucket, path, expiry = 3600) {
-    return await this.client.presignedGetObject(bucket, path, expiry);
-  }
-
-  async listByPrefix(bucket, prefix) {
-    const objects = [];
-    const stream = this.client.listObjectsV2(bucket, prefix);
-
-    for await (const obj of stream) {
-      objects.push(obj);
-    }
-
-    return objects;
-  }
-}
-
-module.exports = StorageConnector;
-```
-
-## Použití v Registry
+## Usage in Registry
 
 ```javascript
-// api_services_registry/src/services/specPublisher.js
-const StorageConnector = require('@shared/connector-storage');
+const StorageConnector = require('@onlineapps/conn-base-storage');
 
 class SpecPublisher {
   constructor() {
@@ -217,11 +102,10 @@ class SpecPublisher {
 }
 ```
 
-## Použití ve službě
+## Usage in Services
 
 ```javascript
-// services/invoicing/src/index.js
-const StorageConnector = require('@shared/connector-storage');
+const StorageConnector = require('@onlineapps/conn-base-storage');
 
 class InvoicingService {
   constructor() {
@@ -256,22 +140,21 @@ class InvoicingService {
 }
 ```
 
-## Bezpečnost
+## Security
 
-### Přístupová práva (buckets)
-- `registry/` - Read-only pro služby, write pro Registry
-- `workflow/` - Read/write pro workflow komponenty
-- `services/` - Read/write pro služby (každá má svůj prefix)
+### Bucket Access Rights
+- `registry/` - Read-only for services, write for Registry
+- `workflow/` - Read/write for workflow components
+- `services/` - Read/write for services (each has own prefix)
 
-### Network isolation
-- MinIO běží pouze v internal Docker network
-- Externí přístup pouze přes pre-signed URLs
+### Network Isolation
+- MinIO runs only in internal Docker network
+- External access only via pre-signed URLs
 
 ## Testing
 
 ```javascript
-// test/connector-storage.test.js
-const StorageConnector = require('../index');
+const StorageConnector = require('@onlineapps/conn-base-storage');
 
 describe('StorageConnector', () => {
   let storage;
@@ -286,7 +169,6 @@ describe('StorageConnector', () => {
   test('upload and download with fingerprint', async () => {
     const content = JSON.stringify({ test: 'data' });
 
-    // Upload
     const upload = await storage.uploadWithFingerprint(
       'test',
       content,
@@ -295,7 +177,6 @@ describe('StorageConnector', () => {
 
     expect(upload.fingerprint).toBeDefined();
 
-    // Download and verify
     const downloaded = await storage.downloadWithVerification(
       'test',
       upload.path,
@@ -322,20 +203,20 @@ MINIO_HOST=localhost
 MINIO_PORT=33025
 ```
 
-## Výhody tohoto přístupu
+## Benefits
 
-1. **Jednotné API** - Všechny služby používají stejnou knihovnu
-2. **Fingerprint built-in** - Automatická správa immutable obsahu
-3. **Verification** - Ověření integrity při stahování
-4. **Pre-signed URLs** - Bezpečný externí přístup
-5. **Efektivní** - Přímý streaming, žádné MQ overhead
-6. **Standard** - S3 API je průmyslový standard
+1. **Unified API** - All services use same library
+2. **Built-in Fingerprints** - Automatic immutable content management
+3. **Verification** - Integrity check on download
+4. **Pre-signed URLs** - Secure external access
+5. **Efficient** - Direct streaming, no MQ overhead
+6. **Standard** - S3 API is industry standard
 
 ---
 
-Toto je správný způsob práce s object storage v microservices architektuře.
-## 📚 Documentation
+**This is the correct way to handle object storage in microservices architecture.**
 
-- [Complete Connectors Documentation](../../../docs/modules/connector.md)
-- [Testing Standards](../../../docs/modules/connector.md#testing-standards)
+## 📚 Documentation
 
+- [Complete Connectors Documentation](../../../docs/architecture/connector.md)
+- [MinIO Infrastructure](../../../docs/guides/INFRASTRUCTURE.md#minio-object-storage)

package/jest.config.js

@@ -7,7 +7,7 @@ module.exports = {
     '!src/**/*.spec.js'
   ],
   testMatch: [
-    '**/test/**/*.test.js',
-    '**/test/**/*.spec.js'
+    '**/tests/**/*.test.js',
+    '**/tests/**/*.spec.js'
   ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onlineapps/conn-base-storage",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "MinIO storage connector with fingerprinting for immutable content storage",
   "main": "src/index.js",
   "scripts": {

package/{test → tests}/component/storage.component.test.js

@@ -87,7 +87,7 @@ jest.mock('minio', () => {
   };
 });
 
-describe('StorageConnector Component Tests', () => {
+describe('StorageConnector Component Tests @component', () => {
   let storage;
   let logger;
   let registry;

package/{test → tests}/integration/storage.integration.test.js

@@ -32,7 +32,7 @@ const checkMinIOConnection = async () => {
   });
 };
 
-describe('StorageConnector Integration Tests', () => {
+describe('StorageConnector Integration Tests @integration', () => {
   let storage;
   let minioAvailable = false;
 

package/{test → tests}/unit/internal-url-adapter.test.js

@@ -4,7 +4,7 @@
 
 const InternalUrlAdapter = require('../../src/internal-url-adapter');
 
-describe('InternalUrlAdapter', () => {
+describe('InternalUrlAdapter @unit', () => {
   let adapter;
 
   beforeEach(() => {

package/{test → tests}/unit/storage.extended.unit.test.js

@@ -9,7 +9,7 @@ const Minio = require('minio');
 // Mock MinIO client
 jest.mock('minio');
 
-describe('StorageConnector Extended Unit Tests', () => {
+describe('StorageConnector Extended Unit Tests @unit', () => {
   let storage;
   let mockMinioClient;
 
@@ -24,6 +24,7 @@ describe('StorageConnector Extended Unit Tests', () => {
       statObject: jest.fn(),
       listObjectsV2: jest.fn(),
       presignedGetUrl: jest.fn(),
+      presignedUrl: jest.fn(), // Add missing mock method
       removeBucket: jest.fn()
     };
 
@@ -291,12 +292,12 @@ describe('StorageConnector Extended Unit Tests', () => {
 
     test('should generate presigned URL', async () => {
       const mockUrl = 'https://minio.example.com/bucket/object?signature=xyz';
-      mockMinioClient.presignedGetUrl.mockResolvedValue(mockUrl);
+      mockMinioClient.presignedUrl.mockResolvedValue(mockUrl);
 
       const url = await storage.getPresignedUrl('test-bucket', 'test-object', 3600);
 
       expect(url).toBe(mockUrl);
-      expect(mockMinioClient.presignedGetUrl).toHaveBeenCalledWith(
+      expect(mockMinioClient.presignedUrl).toHaveBeenCalledWith(
         'GET',
         'test-bucket',
         'test-object',
@@ -305,11 +306,11 @@ describe('StorageConnector Extended Unit Tests', () => {
     });
 
     test('should use default expiry', async () => {
-      mockMinioClient.presignedGetUrl.mockResolvedValue('https://example.com');
+      mockMinioClient.presignedUrl.mockResolvedValue('https://example.com');
 
       await storage.getPresignedUrl('bucket', 'object');
 
-      expect(mockMinioClient.presignedGetUrl).toHaveBeenCalledWith(
+      expect(mockMinioClient.presignedUrl).toHaveBeenCalledWith(
         'GET',
         'bucket',
         'object',

package/{test → tests}/unit/storage.unit.test.js

@@ -27,6 +27,7 @@ jest.mock('minio', () => {
       listObjectsV2: jest.fn(),
       presignedGetObject: jest.fn(),
       presignedGetUrl: jest.fn(),
+      presignedUrl: jest.fn(), // Add missing mock method
       useSSL: false,
       port: 9000,
       host: 'localhost'
@@ -34,7 +35,7 @@ jest.mock('minio', () => {
   };
 });
 
-describe('StorageConnector Unit Tests', () => {
+describe('StorageConnector Unit Tests @unit', () => {
   describe('Initialization', () => {
     test('should create instance with default config', () => {
       const storage = new StorageConnector();
@@ -328,12 +329,12 @@ describe('StorageConnector Unit Tests', () => {
 
     test('should generate presigned URL with mocked client', async () => {
       const expectedUrl = 'http://localhost:9000/bucket/object?signature=xyz';
-      mockClient.presignedGetUrl.mockResolvedValue(expectedUrl);
+      mockClient.presignedUrl.mockResolvedValue(expectedUrl);
 
       const url = await storage.getPresignedUrl('test-bucket', 'test-object');
 
       expect(url).toBe(expectedUrl);
-      expect(mockClient.presignedGetUrl).toHaveBeenCalledWith(
+      expect(mockClient.presignedUrl).toHaveBeenCalledWith(
         'GET',
         'test-bucket',
         'test-object',