Update README.md to provide a comprehensive overview of The Order monorepo, including repository structure, quickstart guide, development workflow, and contribution guidelines.
This commit is contained in:
7
packages/storage/src/index.ts
Normal file
7
packages/storage/src/index.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
/**
|
||||
* The Order Storage Package
|
||||
*/
|
||||
|
||||
export * from './storage';
|
||||
export * from './worm';
|
||||
|
||||
43
packages/storage/src/storage.ts
Normal file
43
packages/storage/src/storage.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
/**
|
||||
* Storage abstraction for S3/GCS
|
||||
*/
|
||||
|
||||
export interface StorageConfig {
|
||||
provider: 's3' | 'gcs';
|
||||
bucket: string;
|
||||
region?: string;
|
||||
accessKeyId?: string;
|
||||
secretAccessKey?: string;
|
||||
}
|
||||
|
||||
export interface StorageObject {
|
||||
key: string;
|
||||
content: Buffer | string;
|
||||
contentType?: string;
|
||||
metadata?: Record<string, string>;
|
||||
}
|
||||
|
||||
export class StorageClient {
|
||||
constructor(private config: StorageConfig) {}
|
||||
|
||||
async upload(object: StorageObject): Promise<string> {
|
||||
// Implementation for file upload
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
|
||||
async download(key: string): Promise<Buffer> {
|
||||
// Implementation for file download
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
|
||||
async delete(key: string): Promise<void> {
|
||||
// Implementation for file deletion
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
|
||||
async getPresignedUrl(key: string, expiresIn: number): Promise<string> {
|
||||
// Implementation for presigned URL generation
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
}
|
||||
|
||||
26
packages/storage/src/worm.ts
Normal file
26
packages/storage/src/worm.ts
Normal file
@@ -0,0 +1,26 @@
|
||||
/**
|
||||
* WORM (Write Once Read Many) mode storage
|
||||
*/
|
||||
|
||||
import { StorageClient, StorageObject } from './storage';
|
||||
|
||||
export class WORMStorage extends StorageClient {
|
||||
async upload(object: StorageObject): Promise<string> {
|
||||
// WORM mode: prevent overwrites
|
||||
const exists = await this.objectExists(object.key);
|
||||
if (exists) {
|
||||
throw new Error(`Object ${object.key} already exists in WORM storage`);
|
||||
}
|
||||
return super.upload(object);
|
||||
}
|
||||
|
||||
async delete(key: string): Promise<void> {
|
||||
throw new Error('Deletion not allowed in WORM mode');
|
||||
}
|
||||
|
||||
private async objectExists(key: string): Promise<boolean> {
|
||||
// Implementation to check if object exists
|
||||
throw new Error('Not implemented');
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user