@guren/server 0.2.0-alpha.7 → 1.0.0-rc.9

package/dist/storage/index.d.ts

@@ -0,0 +1,196 @@
+import { b as StorageDriver, L as LocalDriverOptions, P as PutOptions, F as FileMetadata, e as S3DriverOptions, M as MemoryDriverOptions } from '../StorageManager-oZTHqaza.js';
+export { D as DiskConfig, f as DriverConfig, a as StorageConfig, c as StorageDriverFactory, S as StorageManager, d as createStorageManager } from '../StorageManager-oZTHqaza.js';
+
+/**
+ * Local filesystem storage driver.
+ *
+ * @example
+ * ```ts
+ * const driver = new LocalDriver({
+ *   root: './storage/app',
+ *   url: '/storage',
+ * })
+ *
+ * await driver.put('avatars/user-1.jpg', imageBuffer)
+ * const url = driver.url('avatars/user-1.jpg')
+ * ```
+ */
+declare class LocalDriver implements StorageDriver {
+    private readonly root;
+    private readonly baseUrl;
+    private readonly defaultVisibility;
+    constructor(options: LocalDriverOptions);
+    /**
+     * Get the full path for a file.
+     */
+    private fullPath;
+    /**
+     * Ensure the directory exists.
+     */
+    private ensureDirectory;
+    put(path: string, content: Buffer | string, options?: PutOptions): Promise<string>;
+    putFile(path: string, localPath: string, options?: PutOptions): Promise<string>;
+    get(path: string): Promise<Buffer | null>;
+    getAsString(path: string): Promise<string | null>;
+    exists(path: string): Promise<boolean>;
+    delete(path: string): Promise<boolean>;
+    deleteMany(paths: string[]): Promise<number>;
+    copy(from: string, to: string): Promise<string>;
+    move(from: string, to: string): Promise<string>;
+    url(path: string): string;
+    temporaryUrl(path: string, expiration: Date): Promise<string>;
+    size(path: string): Promise<number>;
+    lastModified(path: string): Promise<Date>;
+    metadata(path: string): Promise<FileMetadata | null>;
+    files(directory: string): Promise<string[]>;
+    directories(directory: string): Promise<string[]>;
+    allFiles(directory: string): Promise<string[]>;
+    makeDirectory(path: string): Promise<void>;
+    deleteDirectory(path: string): Promise<void>;
+    setVisibility(path: string, visibility: 'public' | 'private'): Promise<void>;
+    getVisibility(path: string): Promise<'public' | 'private'>;
+    /**
+     * Get the root directory.
+     */
+    getRoot(): string;
+}
+
+/**
+ * AWS S3 storage driver.
+ *
+ * @example
+ * ```ts
+ * import { S3Client } from '@aws-sdk/client-s3'
+ *
+ * const client = new S3Client({ region: 'ap-northeast-1' })
+ * const driver = new S3Driver({
+ *   client,
+ *   bucket: 'my-bucket',
+ * })
+ *
+ * await driver.put('avatars/user-1.jpg', imageBuffer)
+ * const url = driver.url('avatars/user-1.jpg')
+ * ```
+ */
+declare class S3Driver implements StorageDriver {
+    private readonly options;
+    private client;
+    private readonly bucket;
+    private readonly region;
+    private readonly endpoint?;
+    private readonly accessKeyId?;
+    private readonly secretAccessKey?;
+    private readonly prefix;
+    private readonly baseUrl;
+    private readonly defaultVisibility;
+    constructor(options: S3DriverOptions);
+    /**
+     * Get or create the S3 client.
+     */
+    private getClient;
+    /**
+     * Get the prefixed key.
+     */
+    private prefixKey;
+    /**
+     * Get ACL from visibility.
+     */
+    private getAcl;
+    put(path: string, content: Buffer | string, options?: PutOptions): Promise<string>;
+    putFile(path: string, localPath: string, options?: PutOptions): Promise<string>;
+    get(path: string): Promise<Buffer | null>;
+    getAsString(path: string): Promise<string | null>;
+    exists(path: string): Promise<boolean>;
+    delete(path: string): Promise<boolean>;
+    deleteMany(paths: string[]): Promise<number>;
+    copy(from: string, to: string): Promise<string>;
+    move(from: string, to: string): Promise<string>;
+    url(path: string): string;
+    temporaryUrl(path: string, expiration: Date): Promise<string>;
+    size(path: string): Promise<number>;
+    lastModified(path: string): Promise<Date>;
+    metadata(path: string): Promise<FileMetadata | null>;
+    files(directory: string): Promise<string[]>;
+    directories(directory: string): Promise<string[]>;
+    allFiles(directory: string): Promise<string[]>;
+    makeDirectory(path: string): Promise<void>;
+    deleteDirectory(path: string): Promise<void>;
+    setVisibility(path: string, visibility: 'public' | 'private'): Promise<void>;
+    getVisibility(path: string): Promise<'public' | 'private'>;
+    /**
+     * Get the bucket name.
+     */
+    getBucket(): string;
+    /**
+     * Get the prefix.
+     */
+    getPrefix(): string;
+}
+
+/**
+ * In-memory storage driver for testing.
+ *
+ * @example
+ * ```ts
+ * const driver = new MemoryDriver()
+ *
+ * await driver.put('avatars/user-1.jpg', imageBuffer)
+ * const content = await driver.get('avatars/user-1.jpg')
+ * ```
+ */
+declare class MemoryDriver implements StorageDriver {
+    private readonly storage;
+    private readonly baseUrl;
+    constructor(options?: MemoryDriverOptions);
+    /**
+     * Normalize path (remove leading/trailing slashes).
+     */
+    private normalizePath;
+    /**
+     * Get directory from path.
+     */
+    private getDirectory;
+    /**
+     * Check if a path is in a directory.
+     */
+    private isInDirectory;
+    /**
+     * Check if a path is under a directory (recursive).
+     */
+    private isUnderDirectory;
+    put(path: string, content: Buffer | string, options?: PutOptions): Promise<string>;
+    putFile(path: string, localPath: string, options?: PutOptions): Promise<string>;
+    get(path: string): Promise<Buffer | null>;
+    getAsString(path: string): Promise<string | null>;
+    exists(path: string): Promise<boolean>;
+    delete(path: string): Promise<boolean>;
+    deleteMany(paths: string[]): Promise<number>;
+    copy(from: string, to: string): Promise<string>;
+    move(from: string, to: string): Promise<string>;
+    url(path: string): string;
+    temporaryUrl(path: string, expiration: Date): Promise<string>;
+    size(path: string): Promise<number>;
+    lastModified(path: string): Promise<Date>;
+    metadata(path: string): Promise<FileMetadata | null>;
+    files(directory: string): Promise<string[]>;
+    directories(directory: string): Promise<string[]>;
+    allFiles(directory: string): Promise<string[]>;
+    makeDirectory(path: string): Promise<void>;
+    deleteDirectory(path: string): Promise<void>;
+    setVisibility(path: string, visibility: 'public' | 'private'): Promise<void>;
+    getVisibility(path: string): Promise<'public' | 'private'>;
+    /**
+     * Clear all files (for testing).
+     */
+    clear(): void;
+    /**
+     * Get the number of stored files.
+     */
+    count(): number;
+    /**
+     * Get all stored file paths.
+     */
+    getAllPaths(): string[];
+}
+
+export { FileMetadata, LocalDriver, LocalDriverOptions, MemoryDriver, MemoryDriverOptions, PutOptions, S3Driver, S3DriverOptions, StorageDriver };