How afzal09/bucket-storage-service works
This is an S3-shaped object-storage service: clients obtain access keys, sign API requests, then manage buckets and object data through the NestJS controllers. The core path covers authorization, bucket policy checks, object metadata/version handling, and blob storage; multipart uploads stage and assemble parts before finalizing an object. Separate product branches provide encryption and presigned URLs, lifecycle processing, notifications, replication, auditing, and a dependency-free signing/streaming SDK. Some subsystem wiring is unsampled, so unverified links are dashed.
Main entry points: objects.service.ts Object versions · objects.controller.ts Object routes · storage.service.ts Storage facade · buckets.controller.ts Bucket routes
Components 23
API and identity
- Key API
src/auth/auth.controller.ts - Key and signature service
src/auth/auth.service.ts - Signature guard
src/auth/guards/signature.guard.ts - Bucket routes
src/buckets/buckets.controller.ts - Object routes
src/objects/objects.controller.ts
Storage domains
- Bucket management
src/buckets/buckets.service.ts - Object versions
src/objects/objects.service.ts - Multipart uploads
src/multipart/multipart.service.ts - Storage facade
src/storage/storage.service.ts - Local disk adapter
src/storage/adapters/local-disk.adapter.ts - S3-compatible adapter
src/storage/adapters/s3-compatible.adapter.ts - Bucket and object metadata
src/objects/entities/object.entity.ts
Access and protection
- Bucket policies
src/access-control/policy.service.ts - Data encryption
src/access-control/encryption.service.ts - Presigned URLs
src/access-control/presigned-url.service.ts
Background operations
- Lifecycle processing
src/lifecycle/lifecycle.service.ts - Daily scheduler
src/lifecycle/lifecycle.scheduler.ts - Event publisher
src/notifications/event-publisher.service.ts - Webhook dispatch
src/notifications/webhook-dispatcher.service.ts - Replication
src/replication/replication.service.ts - Audit logging
src/audit/audit.service.ts
Client SDK
- TypeScript SDK
packages/sdk/src/client.ts
Other components
- Storage client
Connections 31
- Storage client → TypeScript SDK: uses
README.md - TypeScript SDK → Key API: signs requests
- Storage client → Key API: creates keys
README.md - Key API → Key and signature service: creates or revokes
src/auth/auth.controller.ts - Signature guard → Key and signature service: verifies signature
src/auth/guards/signature.guard.ts - Storage client → Bucket routes: manages buckets
README.md - Storage client → Object routes: manages objects
README.md - Bucket routes → Bucket management: dispatches bucket actions
src/buckets/buckets.controller.ts - Bucket routes → Bucket policies: configures policy
src/buckets/buckets.controller.ts - Bucket routes → Object versions: lists objects
src/buckets/buckets.controller.ts - Object routes → Bucket management: looks up bucket
src/objects/objects.controller.ts - Object routes → Bucket policies: authorizes actions
src/objects/objects.controller.ts - Object routes → Presigned URLs: generates URL
src/objects/objects.controller.ts - Object routes → Object versions: dispatches object actions
src/objects/objects.controller.ts - Object routes → Multipart uploads: dispatches upload parts
src/objects/objects.controller.ts - Object versions → Bucket management: looks up bucket
src/objects/objects.service.ts - Object versions → Storage facade: reads and writes blobs
src/objects/objects.service.ts - Object versions → Data encryption: encrypts data keys
src/objects/objects.service.ts - Object versions → Event publisher: publishes events
src/objects/objects.service.ts - Multipart uploads → Storage facade: stages and joins parts
src/multipart/multipart.service.ts - Multipart uploads → Object versions: finalizes upload
src/multipart/multipart.service.ts - Storage facade → Local disk adapter: delegates storage
- Storage facade → S3-compatible adapter: delegates storage
- Bucket management → Bucket and object metadata: queries object records
src/buckets/buckets.service.ts - Object versions → Bucket and object metadata: persists versions
src/objects/objects.service.ts - Key and signature service → Data encryption: protects key secrets
src/auth/auth.service.ts - Daily scheduler → Lifecycle processing: runs sweep
- Lifecycle processing → Storage facade: transitions or deletes blobs
src/lifecycle/lifecycle.service.ts - Event publisher → Webhook dispatch: dispatches notifications
src/notifications/webhook-dispatcher.service.ts - Replication → Object versions: uses object service
src/replication/replication.service.ts - Audit logging → Bucket and object metadata: stores audit records