koishi-plugin-chatluna-storage-service 0.0.11 → 1.0.1

package/lib/backends/base.d.ts

@@ -0,0 +1,74 @@
+/**
+ * Storage backend interface and types
+ */
+export interface StorageResult {
+    /** Unique key/path for the stored file */
+    key: string;
+    /** Public URL if backend supports it, undefined otherwise */
+    publicUrl?: string;
+}
+export interface StorageBackend {
+    /** Backend type identifier */
+    readonly type: StorageBackendType;
+    /** Whether this backend provides public URLs */
+    readonly hasPublicUrl: boolean;
+    /**
+     * Upload a file to storage
+     * @param buffer File content
+     * @param filename Original filename
+     * @returns Storage result with key and optional public URL
+     */
+    upload(buffer: Buffer, filename: string): Promise<StorageResult>;
+    /**
+     * Download a file from storage
+     * @param key File key/path
+     * @returns File content as Buffer
+     */
+    download(key: string): Promise<Buffer>;
+    /**
+     * Delete a file from storage
+     * @param key File key/path
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Check if a file exists in storage
+     * @param key File key/path
+     */
+    exists(key: string): Promise<boolean>;
+    /**
+     * Initialize the storage backend
+     */
+    init(): Promise<void>;
+}
+export type StorageBackendType = 'local' | 's3' | 'webdav' | 'r2';
+export interface LocalStorageConfig {
+    type: 'local';
+    storagePath: string;
+}
+export interface S3StorageConfig {
+    type: 's3';
+    endpoint: string;
+    bucket: string;
+    region: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    publicUrl?: string;
+    pathStyle?: boolean;
+}
+export interface WebDAVStorageConfig {
+    type: 'webdav';
+    endpoint: string;
+    username?: string;
+    password?: string;
+    basePath?: string;
+    publicUrl?: string;
+}
+export interface R2StorageConfig {
+    type: 'r2';
+    accountId: string;
+    bucket: string;
+    accessKeyId: string;
+    secretAccessKey: string;
+    publicUrl?: string;
+}
+export type StorageConfig = LocalStorageConfig | S3StorageConfig | WebDAVStorageConfig | R2StorageConfig;

package/lib/backends/index.d.ts

@@ -0,0 +1,7 @@
+export * from './base';
+export { LocalStorageBackend } from './local';
+export { S3StorageBackend } from './s3';
+export { WebDAVStorageBackend } from './webdav';
+export { R2StorageBackend } from './r2';
+import { StorageBackend, StorageConfig } from './base';
+export declare function createStorageBackend(config: StorageConfig): StorageBackend;

package/lib/backends/local.d.ts

@@ -0,0 +1,13 @@
+import { StorageBackend, StorageResult, LocalStorageConfig } from './base';
+export declare class LocalStorageBackend implements StorageBackend {
+    private config;
+    readonly type: "local";
+    readonly hasPublicUrl = false;
+    private basePath;
+    constructor(config: LocalStorageConfig);
+    init(): Promise<void>;
+    upload(buffer: Buffer, filename: string): Promise<StorageResult>;
+    download(key: string): Promise<Buffer>;
+    delete(key: string): Promise<void>;
+    exists(key: string): Promise<boolean>;
+}

package/lib/backends/r2.d.ts

@@ -0,0 +1,19 @@
+import { StorageBackend, StorageResult, R2StorageConfig } from './base';
+/**
+ * Cloudflare R2 Storage Backend
+ * R2 is S3-compatible, but uses a specific endpoint format
+ */
+export declare class R2StorageBackend implements StorageBackend {
+    private config;
+    readonly type: "r2";
+    readonly hasPublicUrl: boolean;
+    private endpoint;
+    constructor(config: R2StorageConfig);
+    init(): Promise<void>;
+    upload(buffer: Buffer, filename: string): Promise<StorageResult>;
+    download(key: string): Promise<Buffer>;
+    delete(key: string): Promise<void>;
+    exists(key: string): Promise<boolean>;
+    private generateAuthorizationHeader;
+    private getSigningKey;
+}

package/lib/backends/s3.d.ts

@@ -0,0 +1,15 @@
+import { StorageBackend, StorageResult, S3StorageConfig } from './base';
+export declare class S3StorageBackend implements StorageBackend {
+    private config;
+    readonly type: "s3";
+    readonly hasPublicUrl: boolean;
+    constructor(config: S3StorageConfig);
+    init(): Promise<void>;
+    upload(buffer: Buffer, filename: string): Promise<StorageResult>;
+    download(key: string): Promise<Buffer>;
+    delete(key: string): Promise<void>;
+    exists(key: string): Promise<boolean>;
+    private buildS3Url;
+    private generateAuthorizationHeader;
+    private getSigningKey;
+}

package/lib/backends/webdav.d.ts

@@ -0,0 +1,18 @@
+import { StorageBackend, StorageResult, WebDAVStorageConfig } from './base';
+export declare class WebDAVStorageBackend implements StorageBackend {
+    private config;
+    readonly type: "webdav";
+    readonly hasPublicUrl: boolean;
+    private basePath;
+    constructor(config: WebDAVStorageConfig);
+    init(): Promise<void>;
+    upload(buffer: Buffer, filename: string): Promise<StorageResult>;
+    download(key: string): Promise<Buffer>;
+    delete(key: string): Promise<void>;
+    exists(key: string): Promise<boolean>;
+    private ensureBasePath;
+    private ensureDirectory;
+    private b64;
+    private trimSlash;
+    private encodePath;
+}