@opendatalabs/vana-sdk 0.1.0-alpha.ee24d86 → 0.1.0-alpha.eebb656

package/dist/storage/index.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Storage API for Vana SDK
+ *
+ * Provides unified interface for different storage providers
+ * to upload, download, and manage user data files.
+ *
+ * ## Storage Provider Decision Tree
+ *
+ * Choose your storage provider based on your needs:
+ *
+ * **Need full CRUD operations and metadata?**
+ * - ✅ Use `PinataStorage` - Managed IPFS with listing, deletion, and rich metadata
+ *
+ * **Want to use your own IPFS infrastructure?**
+ * - ✅ Use `IpfsStorage.forInfura()` - Connect to Infura IPFS service
+ * - ✅ Use `IpfsStorage.forLocalNode()` - Connect to local IPFS node
+ * - ✅ Use `new IpfsStorage()` - Connect to any IPFS-compatible service
+ *
+ * **Want flexible callback-based storage?**
+ * - ✅ Use `CallbackStorage` - Implement storage via custom callbacks (HTTP, WebSocket, etc.)
+ *
+ * **Need Google Drive integration?**
+ * - ✅ Use `GoogleDriveStorage` - Direct Google Drive API with folder management
+ *
+ * @example
+ * ```typescript
+ * // Managed IPFS with full features
+ * const pinata = new PinataStorage({ jwt: "your-jwt" });
+ *
+ * // Standard IPFS with Infura
+ * const ipfs = IpfsStorage.forInfura({ projectId: "...", projectSecret: "..." });
+ *
+ * // Callback-based storage (flexible)
+ * const storage = new CallbackStorage({
+ *   async upload(blob, filename) {
+ *     // Your custom upload logic
+ *     const response = await fetch('/api/upload', { method: 'POST', body: blob });
+ *     const data = await response.json();
+ *     return { url: data.url, size: blob.size, contentType: blob.type };
+ *   },
+ *   async download(identifier) {
+ *     // Your custom download logic
+ *     const response = await fetch(`/api/download/${identifier}`);
+ *     return response.blob();
+ *   }
+ * });
+ * ```
+ */
+export type { StorageProvider, StorageUploadResult, StorageFile, StorageListOptions, StorageProviderConfig, } from "../types/storage";
+export { StorageError } from "../types/storage";
+export { GoogleDriveStorage } from "./providers/google-drive";
+export { IpfsStorage } from "./providers/ipfs";
+export { PinataStorage } from "./providers/pinata";
+export { CallbackStorage } from "./providers/callback-storage";
+export { StorageManager } from "./manager";
+export type { StorageCallbacks, StorageDownloadOptions, StorageListResult, } from "../types/config";

package/dist/storage/index.js

@@ -0,0 +1,15 @@
+import { StorageError } from "../types/storage";
+import { GoogleDriveStorage } from "./providers/google-drive";
+import { IpfsStorage } from "./providers/ipfs";
+import { PinataStorage } from "./providers/pinata";
+import { CallbackStorage } from "./providers/callback-storage";
+import { StorageManager } from "./manager";
+export {
+  CallbackStorage,
+  GoogleDriveStorage,
+  IpfsStorage,
+  PinataStorage,
+  StorageError,
+  StorageManager
+};
+//# sourceMappingURL=index.js.map

package/dist/storage/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/storage/index.ts"],"sourcesContent":["/**\n * Storage API for Vana SDK\n *\n * Provides unified interface for different storage providers\n * to upload, download, and manage user data files.\n *\n * ## Storage Provider Decision Tree\n *\n * Choose your storage provider based on your needs:\n *\n * **Need full CRUD operations and metadata?**\n * - ✅ Use `PinataStorage` - Managed IPFS with listing, deletion, and rich metadata\n *\n * **Want to use your own IPFS infrastructure?**\n * - ✅ Use `IpfsStorage.forInfura()` - Connect to Infura IPFS service\n * - ✅ Use `IpfsStorage.forLocalNode()` - Connect to local IPFS node\n * - ✅ Use `new IpfsStorage()` - Connect to any IPFS-compatible service\n *\n * **Want flexible callback-based storage?**\n * - ✅ Use `CallbackStorage` - Implement storage via custom callbacks (HTTP, WebSocket, etc.)\n *\n * **Need Google Drive integration?**\n * - ✅ Use `GoogleDriveStorage` - Direct Google Drive API with folder management\n *\n * @example\n * ```typescript\n * // Managed IPFS with full features\n * const pinata = new PinataStorage({ jwt: \"your-jwt\" });\n *\n * // Standard IPFS with Infura\n * const ipfs = IpfsStorage.forInfura({ projectId: \"...\", projectSecret: \"...\" });\n *\n * // Callback-based storage (flexible)\n * const storage = new CallbackStorage({\n *   async upload(blob, filename) {\n *     // Your custom upload logic\n *     const response = await fetch('/api/upload', { method: 'POST', body: blob });\n *     const data = await response.json();\n *     return { url: data.url, size: blob.size, contentType: blob.type };\n *   },\n *   async download(identifier) {\n *     // Your custom download logic\n *     const response = await fetch(`/api/download/${identifier}`);\n *     return response.blob();\n *   }\n * });\n * ```\n */\n\n// Re-export storage types from types module to avoid circular dependencies\nexport type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n  StorageProviderConfig,\n} from \"../types/storage\";\n\nexport { StorageError } from \"../types/storage\";\n\n// Export storage providers\nexport { GoogleDriveStorage } from \"./providers/google-drive\";\nexport { IpfsStorage } from \"./providers/ipfs\";\nexport { PinataStorage } from \"./providers/pinata\";\nexport { CallbackStorage } from \"./providers/callback-storage\";\n\n// Export storage manager\nexport { StorageManager } from \"./manager\";\n\n// Export storage callback types\nexport type {\n  StorageCallbacks,\n  StorageDownloadOptions,\n  StorageListResult,\n} from \"../types/config\";\n"],"mappings":"AA0DA,SAAS,oBAAoB;AAG7B,SAAS,0BAA0B;AACnC,SAAS,mBAAmB;AAC5B,SAAS,qBAAqB;AAC9B,SAAS,uBAAuB;AAGhC,SAAS,sBAAsB;","names":[]}

package/dist/storage/manager.cjs

@@ -0,0 +1,189 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var manager_exports = {};
+__export(manager_exports, {
+  StorageManager: () => StorageManager
+});
+module.exports = __toCommonJS(manager_exports);
+var import_storage = require("../types/storage");
+class StorageManager {
+  providers = /* @__PURE__ */ new Map();
+  defaultProvider = null;
+  /**
+   * Registers a storage provider with the manager.
+   *
+   * @remarks
+   * This method adds a new storage provider to the manager's registry and optionally
+   * sets it as the default provider for subsequent operations. If no default provider
+   * is currently set, the first registered provider automatically becomes the default.
+   * @param name - Unique identifier for the provider
+   * @param provider - The storage provider instance implementing the `StorageProvider` interface
+   * @param isDefault - Whether this provider should be set as the default (defaults to `false`)
+   * @example
+   * ```typescript
+   * const pinata = new PinataStorage({ jwt: 'your-jwt-token' });
+   * storage.register('pinata', pinata, true); // Set as default
+   *
+   * const ipfs = new IPFSStorage({ apiEndpoint: 'https://...' });
+   * storage.register('ipfs', ipfs); // Not default
+   * ```
+   */
+  register(name, provider, isDefault = false) {
+    this.providers.set(name, provider);
+    if (isDefault || this.defaultProvider === null) {
+      this.defaultProvider = name;
+    }
+  }
+  /**
+   * Get a registered storage provider
+   *
+   * @param name - Provider identifier, uses default if not specified
+   * @returns Storage provider instance
+   */
+  getProvider(name) {
+    const providerName = name ?? this.defaultProvider;
+    if (!providerName) {
+      throw new import_storage.StorageError(
+        "No storage provider specified and no default provider set",
+        "NO_PROVIDER",
+        "manager"
+      );
+    }
+    const provider = this.providers.get(providerName);
+    if (!provider) {
+      throw new import_storage.StorageError(
+        `Storage provider '${providerName}' not found`,
+        "PROVIDER_NOT_FOUND",
+        "manager"
+      );
+    }
+    return provider;
+  }
+  /**
+   * List all registered providers
+   *
+   * @returns Array of provider names
+   */
+  listProviders() {
+    return Array.from(this.providers.keys());
+  }
+  /**
+   * Get the default provider name
+   *
+   * @returns Default provider name or null
+   */
+  getDefaultProvider() {
+    return this.defaultProvider;
+  }
+  /**
+   * Set the default provider
+   *
+   * @param name - Provider identifier
+   */
+  setDefaultProvider(name) {
+    if (!this.providers.has(name)) {
+      throw new import_storage.StorageError(
+        `Cannot set default provider '${name}': provider not registered`,
+        "PROVIDER_NOT_FOUND",
+        "manager"
+      );
+    }
+    this.defaultProvider = name;
+  }
+  /**
+   * Uploads a file using the specified or default storage provider.
+   *
+   * @remarks
+   * This method uploads a file to the specified provider or falls back to the default
+   * provider if none is specified. The upload result includes the storage URL, file size,
+   * content type, and provider-specific metadata that can be used for subsequent operations.
+   * @param file - The file blob to upload
+   * @param filename - Optional custom filename (defaults to auto-generated name)
+   * @param providerName - Optional provider identifier (uses default if not specified)
+   * @returns A Promise that resolves to the storage upload result with URL and metadata
+   * @throws {StorageError} When no provider is available or upload fails
+   * @example
+   * ```typescript
+   * // Upload to default provider
+   * const result = await storage.upload(fileBlob, 'data.json');
+   * console.log(`Uploaded to: ${result.url}`);
+   *
+   * // Upload to specific provider
+   * const result2 = await storage.upload(fileBlob, 'data.json', 'pinata');
+   * ```
+   */
+  async upload(file, filename, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.upload(file, filename);
+  }
+  /**
+   * Download a file using the specified or default provider
+   *
+   * @param url - The storage URL
+   * @param providerName - Optional provider to use
+   * @returns Promise with file blob
+   */
+  async download(url, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.download(url);
+  }
+  /**
+   * List files using the specified or default provider
+   *
+   * @param options - Optional filtering and pagination
+   * @param providerName - Optional provider to use
+   * @returns Promise with file list
+   */
+  async list(options, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.list(options);
+  }
+  /**
+   * Delete a file using the specified or default provider
+   *
+   * @param url - The storage URL
+   * @param providerName - Optional provider to use
+   * @returns Promise with success status
+   */
+  async delete(url, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.delete(url);
+  }
+  /**
+   * Get list of registered storage provider names
+   *
+   * @returns Array of provider names
+   */
+  getStorageProviders() {
+    return Array.from(this.providers.keys());
+  }
+  /**
+   * Get the default storage provider name
+   *
+   * @returns Default provider name or undefined
+   */
+  getDefaultStorageProvider() {
+    return this.defaultProvider ?? void 0;
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  StorageManager
+});
+//# sourceMappingURL=manager.cjs.map

package/dist/storage/manager.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/storage/manager.ts"],"sourcesContent":["import type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n} from \"../types/storage\";\nimport { StorageError } from \"../types/storage\";\n\n/**\n * Manages multiple storage providers with a unified interface for file operations.\n *\n * @remarks\n * The StorageManager provides a consistent API for uploading, downloading, and managing\n * files across different storage backends including IPFS, Pinata, Google Drive, and\n * server-managed storage. It handles provider registration, default provider selection,\n * and automatic fallback scenarios for robust file operations.\n *\n * Used internally by DataController for encrypted file storage, but can also be used\n * directly for custom storage workflows. Each provider implements the `StorageProvider`\n * interface to ensure consistent behavior across different storage backends.\n *\n * The manager supports provider-specific configurations and features while maintaining\n * a uniform API surface for applications.\n * @example\n * ```typescript\n * import { StorageManager, IPFSStorage, PinataStorage } from '@opendatalabs/vana-sdk';\n *\n * const storage = new StorageManager();\n *\n * // Register multiple providers\n * storage.register('ipfs', new IPFSStorage({\n *   apiEndpoint: 'https://api.pinata.cloud/pinning/pinFileToIPFS'\n * }), true);\n * storage.register('pinata', new PinataStorage({\n *   jwt: 'your-pinata-jwt-token'\n * }));\n *\n * // Upload to default provider\n * const result = await storage.upload(fileBlob, 'myfile.json');\n *\n * // Upload to specific provider\n * const result2 = await storage.upload(fileBlob, 'myfile.json', 'pinata');\n * ```\n * @category Storage\n * @see {@link https://docs.vana.com/developer/vana-sdk-documentation/core-modules/storage-providers | Storage Providers Guide} for configuration details\n */\nexport class StorageManager {\n  private providers: Map<string, StorageProvider> = new Map();\n  private defaultProvider: string | null = null;\n\n  /**\n   * Registers a storage provider with the manager.\n   *\n   * @remarks\n   * This method adds a new storage provider to the manager's registry and optionally\n   * sets it as the default provider for subsequent operations. If no default provider\n   * is currently set, the first registered provider automatically becomes the default.\n   * @param name - Unique identifier for the provider\n   * @param provider - The storage provider instance implementing the `StorageProvider` interface\n   * @param isDefault - Whether this provider should be set as the default (defaults to `false`)\n   * @example\n   * ```typescript\n   * const pinata = new PinataStorage({ jwt: 'your-jwt-token' });\n   * storage.register('pinata', pinata, true); // Set as default\n   *\n   * const ipfs = new IPFSStorage({ apiEndpoint: 'https://...' });\n   * storage.register('ipfs', ipfs); // Not default\n   * ```\n   */\n  register(name: string, provider: StorageProvider, isDefault = false): void {\n    this.providers.set(name, provider);\n\n    if (isDefault || this.defaultProvider === null) {\n      this.defaultProvider = name;\n    }\n  }\n\n  /**\n   * Get a registered storage provider\n   *\n   * @param name - Provider identifier, uses default if not specified\n   * @returns Storage provider instance\n   */\n  getProvider(name?: string): StorageProvider {\n    const providerName = name ?? this.defaultProvider;\n\n    if (!providerName) {\n      throw new StorageError(\n        \"No storage provider specified and no default provider set\",\n        \"NO_PROVIDER\",\n        \"manager\",\n      );\n    }\n\n    const provider = this.providers.get(providerName);\n    if (!provider) {\n      throw new StorageError(\n        `Storage provider '${providerName}' not found`,\n        \"PROVIDER_NOT_FOUND\",\n        \"manager\",\n      );\n    }\n\n    return provider;\n  }\n\n  /**\n   * List all registered providers\n   *\n   * @returns Array of provider names\n   */\n  listProviders(): string[] {\n    return Array.from(this.providers.keys());\n  }\n\n  /**\n   * Get the default provider name\n   *\n   * @returns Default provider name or null\n   */\n  getDefaultProvider(): string | null {\n    return this.defaultProvider;\n  }\n\n  /**\n   * Set the default provider\n   *\n   * @param name - Provider identifier\n   */\n  setDefaultProvider(name: string): void {\n    if (!this.providers.has(name)) {\n      throw new StorageError(\n        `Cannot set default provider '${name}': provider not registered`,\n        \"PROVIDER_NOT_FOUND\",\n        \"manager\",\n      );\n    }\n    this.defaultProvider = name;\n  }\n\n  /**\n   * Uploads a file using the specified or default storage provider.\n   *\n   * @remarks\n   * This method uploads a file to the specified provider or falls back to the default\n   * provider if none is specified. The upload result includes the storage URL, file size,\n   * content type, and provider-specific metadata that can be used for subsequent operations.\n   * @param file - The file blob to upload\n   * @param filename - Optional custom filename (defaults to auto-generated name)\n   * @param providerName - Optional provider identifier (uses default if not specified)\n   * @returns A Promise that resolves to the storage upload result with URL and metadata\n   * @throws {StorageError} When no provider is available or upload fails\n   * @example\n   * ```typescript\n   * // Upload to default provider\n   * const result = await storage.upload(fileBlob, 'data.json');\n   * console.log(`Uploaded to: ${result.url}`);\n   *\n   * // Upload to specific provider\n   * const result2 = await storage.upload(fileBlob, 'data.json', 'pinata');\n   * ```\n   */\n  async upload(\n    file: Blob,\n    filename?: string,\n    providerName?: string,\n  ): Promise<StorageUploadResult> {\n    const provider = this.getProvider(providerName);\n    return provider.upload(file, filename);\n  }\n\n  /**\n   * Download a file using the specified or default provider\n   *\n   * @param url - The storage URL\n   * @param providerName - Optional provider to use\n   * @returns Promise with file blob\n   */\n  async download(url: string, providerName?: string): Promise<Blob> {\n    const provider = this.getProvider(providerName);\n    return provider.download(url);\n  }\n\n  /**\n   * List files using the specified or default provider\n   *\n   * @param options - Optional filtering and pagination\n   * @param providerName - Optional provider to use\n   * @returns Promise with file list\n   */\n  async list(\n    options?: StorageListOptions,\n    providerName?: string,\n  ): Promise<StorageFile[]> {\n    const provider = this.getProvider(providerName);\n    return provider.list(options);\n  }\n\n  /**\n   * Delete a file using the specified or default provider\n   *\n   * @param url - The storage URL\n   * @param providerName - Optional provider to use\n   * @returns Promise with success status\n   */\n  async delete(url: string, providerName?: string): Promise<boolean> {\n    const provider = this.getProvider(providerName);\n    return provider.delete(url);\n  }\n\n  /**\n   * Get list of registered storage provider names\n   *\n   * @returns Array of provider names\n   */\n  getStorageProviders(): string[] {\n    return Array.from(this.providers.keys());\n  }\n\n  /**\n   * Get the default storage provider name\n   *\n   * @returns Default provider name or undefined\n   */\n  getDefaultStorageProvider(): string | undefined {\n    return this.defaultProvider ?? undefined;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,qBAA6B;AAwCtB,MAAM,eAAe;AAAA,EAClB,YAA0C,oBAAI,IAAI;AAAA,EAClD,kBAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBzC,SAAS,MAAc,UAA2B,YAAY,OAAa;AACzE,SAAK,UAAU,IAAI,MAAM,QAAQ;AAEjC,QAAI,aAAa,KAAK,oBAAoB,MAAM;AAC9C,WAAK,kBAAkB;AAAA,IACzB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,YAAY,MAAgC;AAC1C,UAAM,eAAe,QAAQ,KAAK;AAElC,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAW,KAAK,UAAU,IAAI,YAAY;AAChD,QAAI,CAAC,UAAU;AACb,YAAM,IAAI;AAAA,QACR,qBAAqB,YAAY;AAAA,QACjC;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,gBAA0B;AACxB,WAAO,MAAM,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,qBAAoC;AAClC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,mBAAmB,MAAoB;AACrC,QAAI,CAAC,KAAK,UAAU,IAAI,IAAI,GAAG;AAC7B,YAAM,IAAI;AAAA,QACR,gCAAgC,IAAI;AAAA,QACpC;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,kBAAkB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,MAAM,OACJ,MACA,UACA,cAC8B;AAC9B,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,OAAO,MAAM,QAAQ;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,SAAS,KAAa,cAAsC;AAChE,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,SAAS,GAAG;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,KACJ,SACA,cACwB;AACxB,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,KAAK,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAO,KAAa,cAAyC;AACjE,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,sBAAgC;AAC9B,WAAO,MAAM,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,4BAAgD;AAC9C,WAAO,KAAK,mBAAmB;AAAA,EACjC;AACF;","names":[]}

package/dist/storage/manager.d.ts

@@ -0,0 +1,147 @@
+import type { StorageProvider, StorageUploadResult, StorageFile, StorageListOptions } from "../types/storage";
+/**
+ * Manages multiple storage providers with a unified interface for file operations.
+ *
+ * @remarks
+ * The StorageManager provides a consistent API for uploading, downloading, and managing
+ * files across different storage backends including IPFS, Pinata, Google Drive, and
+ * server-managed storage. It handles provider registration, default provider selection,
+ * and automatic fallback scenarios for robust file operations.
+ *
+ * Used internally by DataController for encrypted file storage, but can also be used
+ * directly for custom storage workflows. Each provider implements the `StorageProvider`
+ * interface to ensure consistent behavior across different storage backends.
+ *
+ * The manager supports provider-specific configurations and features while maintaining
+ * a uniform API surface for applications.
+ * @example
+ * ```typescript
+ * import { StorageManager, IPFSStorage, PinataStorage } from '@opendatalabs/vana-sdk';
+ *
+ * const storage = new StorageManager();
+ *
+ * // Register multiple providers
+ * storage.register('ipfs', new IPFSStorage({
+ *   apiEndpoint: 'https://api.pinata.cloud/pinning/pinFileToIPFS'
+ * }), true);
+ * storage.register('pinata', new PinataStorage({
+ *   jwt: 'your-pinata-jwt-token'
+ * }));
+ *
+ * // Upload to default provider
+ * const result = await storage.upload(fileBlob, 'myfile.json');
+ *
+ * // Upload to specific provider
+ * const result2 = await storage.upload(fileBlob, 'myfile.json', 'pinata');
+ * ```
+ * @category Storage
+ * @see {@link https://docs.vana.com/developer/vana-sdk-documentation/core-modules/storage-providers | Storage Providers Guide} for configuration details
+ */
+export declare class StorageManager {
+    private providers;
+    private defaultProvider;
+    /**
+     * Registers a storage provider with the manager.
+     *
+     * @remarks
+     * This method adds a new storage provider to the manager's registry and optionally
+     * sets it as the default provider for subsequent operations. If no default provider
+     * is currently set, the first registered provider automatically becomes the default.
+     * @param name - Unique identifier for the provider
+     * @param provider - The storage provider instance implementing the `StorageProvider` interface
+     * @param isDefault - Whether this provider should be set as the default (defaults to `false`)
+     * @example
+     * ```typescript
+     * const pinata = new PinataStorage({ jwt: 'your-jwt-token' });
+     * storage.register('pinata', pinata, true); // Set as default
+     *
+     * const ipfs = new IPFSStorage({ apiEndpoint: 'https://...' });
+     * storage.register('ipfs', ipfs); // Not default
+     * ```
+     */
+    register(name: string, provider: StorageProvider, isDefault?: boolean): void;
+    /**
+     * Get a registered storage provider
+     *
+     * @param name - Provider identifier, uses default if not specified
+     * @returns Storage provider instance
+     */
+    getProvider(name?: string): StorageProvider;
+    /**
+     * List all registered providers
+     *
+     * @returns Array of provider names
+     */
+    listProviders(): string[];
+    /**
+     * Get the default provider name
+     *
+     * @returns Default provider name or null
+     */
+    getDefaultProvider(): string | null;
+    /**
+     * Set the default provider
+     *
+     * @param name - Provider identifier
+     */
+    setDefaultProvider(name: string): void;
+    /**
+     * Uploads a file using the specified or default storage provider.
+     *
+     * @remarks
+     * This method uploads a file to the specified provider or falls back to the default
+     * provider if none is specified. The upload result includes the storage URL, file size,
+     * content type, and provider-specific metadata that can be used for subsequent operations.
+     * @param file - The file blob to upload
+     * @param filename - Optional custom filename (defaults to auto-generated name)
+     * @param providerName - Optional provider identifier (uses default if not specified)
+     * @returns A Promise that resolves to the storage upload result with URL and metadata
+     * @throws {StorageError} When no provider is available or upload fails
+     * @example
+     * ```typescript
+     * // Upload to default provider
+     * const result = await storage.upload(fileBlob, 'data.json');
+     * console.log(`Uploaded to: ${result.url}`);
+     *
+     * // Upload to specific provider
+     * const result2 = await storage.upload(fileBlob, 'data.json', 'pinata');
+     * ```
+     */
+    upload(file: Blob, filename?: string, providerName?: string): Promise<StorageUploadResult>;
+    /**
+     * Download a file using the specified or default provider
+     *
+     * @param url - The storage URL
+     * @param providerName - Optional provider to use
+     * @returns Promise with file blob
+     */
+    download(url: string, providerName?: string): Promise<Blob>;
+    /**
+     * List files using the specified or default provider
+     *
+     * @param options - Optional filtering and pagination
+     * @param providerName - Optional provider to use
+     * @returns Promise with file list
+     */
+    list(options?: StorageListOptions, providerName?: string): Promise<StorageFile[]>;
+    /**
+     * Delete a file using the specified or default provider
+     *
+     * @param url - The storage URL
+     * @param providerName - Optional provider to use
+     * @returns Promise with success status
+     */
+    delete(url: string, providerName?: string): Promise<boolean>;
+    /**
+     * Get list of registered storage provider names
+     *
+     * @returns Array of provider names
+     */
+    getStorageProviders(): string[];
+    /**
+     * Get the default storage provider name
+     *
+     * @returns Default provider name or undefined
+     */
+    getDefaultStorageProvider(): string | undefined;
+}

package/dist/storage/manager.js

@@ -0,0 +1,165 @@
+import { StorageError } from "../types/storage";
+class StorageManager {
+  providers = /* @__PURE__ */ new Map();
+  defaultProvider = null;
+  /**
+   * Registers a storage provider with the manager.
+   *
+   * @remarks
+   * This method adds a new storage provider to the manager's registry and optionally
+   * sets it as the default provider for subsequent operations. If no default provider
+   * is currently set, the first registered provider automatically becomes the default.
+   * @param name - Unique identifier for the provider
+   * @param provider - The storage provider instance implementing the `StorageProvider` interface
+   * @param isDefault - Whether this provider should be set as the default (defaults to `false`)
+   * @example
+   * ```typescript
+   * const pinata = new PinataStorage({ jwt: 'your-jwt-token' });
+   * storage.register('pinata', pinata, true); // Set as default
+   *
+   * const ipfs = new IPFSStorage({ apiEndpoint: 'https://...' });
+   * storage.register('ipfs', ipfs); // Not default
+   * ```
+   */
+  register(name, provider, isDefault = false) {
+    this.providers.set(name, provider);
+    if (isDefault || this.defaultProvider === null) {
+      this.defaultProvider = name;
+    }
+  }
+  /**
+   * Get a registered storage provider
+   *
+   * @param name - Provider identifier, uses default if not specified
+   * @returns Storage provider instance
+   */
+  getProvider(name) {
+    const providerName = name ?? this.defaultProvider;
+    if (!providerName) {
+      throw new StorageError(
+        "No storage provider specified and no default provider set",
+        "NO_PROVIDER",
+        "manager"
+      );
+    }
+    const provider = this.providers.get(providerName);
+    if (!provider) {
+      throw new StorageError(
+        `Storage provider '${providerName}' not found`,
+        "PROVIDER_NOT_FOUND",
+        "manager"
+      );
+    }
+    return provider;
+  }
+  /**
+   * List all registered providers
+   *
+   * @returns Array of provider names
+   */
+  listProviders() {
+    return Array.from(this.providers.keys());
+  }
+  /**
+   * Get the default provider name
+   *
+   * @returns Default provider name or null
+   */
+  getDefaultProvider() {
+    return this.defaultProvider;
+  }
+  /**
+   * Set the default provider
+   *
+   * @param name - Provider identifier
+   */
+  setDefaultProvider(name) {
+    if (!this.providers.has(name)) {
+      throw new StorageError(
+        `Cannot set default provider '${name}': provider not registered`,
+        "PROVIDER_NOT_FOUND",
+        "manager"
+      );
+    }
+    this.defaultProvider = name;
+  }
+  /**
+   * Uploads a file using the specified or default storage provider.
+   *
+   * @remarks
+   * This method uploads a file to the specified provider or falls back to the default
+   * provider if none is specified. The upload result includes the storage URL, file size,
+   * content type, and provider-specific metadata that can be used for subsequent operations.
+   * @param file - The file blob to upload
+   * @param filename - Optional custom filename (defaults to auto-generated name)
+   * @param providerName - Optional provider identifier (uses default if not specified)
+   * @returns A Promise that resolves to the storage upload result with URL and metadata
+   * @throws {StorageError} When no provider is available or upload fails
+   * @example
+   * ```typescript
+   * // Upload to default provider
+   * const result = await storage.upload(fileBlob, 'data.json');
+   * console.log(`Uploaded to: ${result.url}`);
+   *
+   * // Upload to specific provider
+   * const result2 = await storage.upload(fileBlob, 'data.json', 'pinata');
+   * ```
+   */
+  async upload(file, filename, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.upload(file, filename);
+  }
+  /**
+   * Download a file using the specified or default provider
+   *
+   * @param url - The storage URL
+   * @param providerName - Optional provider to use
+   * @returns Promise with file blob
+   */
+  async download(url, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.download(url);
+  }
+  /**
+   * List files using the specified or default provider
+   *
+   * @param options - Optional filtering and pagination
+   * @param providerName - Optional provider to use
+   * @returns Promise with file list
+   */
+  async list(options, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.list(options);
+  }
+  /**
+   * Delete a file using the specified or default provider
+   *
+   * @param url - The storage URL
+   * @param providerName - Optional provider to use
+   * @returns Promise with success status
+   */
+  async delete(url, providerName) {
+    const provider = this.getProvider(providerName);
+    return provider.delete(url);
+  }
+  /**
+   * Get list of registered storage provider names
+   *
+   * @returns Array of provider names
+   */
+  getStorageProviders() {
+    return Array.from(this.providers.keys());
+  }
+  /**
+   * Get the default storage provider name
+   *
+   * @returns Default provider name or undefined
+   */
+  getDefaultStorageProvider() {
+    return this.defaultProvider ?? void 0;
+  }
+}
+export {
+  StorageManager
+};
+//# sourceMappingURL=manager.js.map

package/dist/storage/manager.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/storage/manager.ts"],"sourcesContent":["import type {\n  StorageProvider,\n  StorageUploadResult,\n  StorageFile,\n  StorageListOptions,\n} from \"../types/storage\";\nimport { StorageError } from \"../types/storage\";\n\n/**\n * Manages multiple storage providers with a unified interface for file operations.\n *\n * @remarks\n * The StorageManager provides a consistent API for uploading, downloading, and managing\n * files across different storage backends including IPFS, Pinata, Google Drive, and\n * server-managed storage. It handles provider registration, default provider selection,\n * and automatic fallback scenarios for robust file operations.\n *\n * Used internally by DataController for encrypted file storage, but can also be used\n * directly for custom storage workflows. Each provider implements the `StorageProvider`\n * interface to ensure consistent behavior across different storage backends.\n *\n * The manager supports provider-specific configurations and features while maintaining\n * a uniform API surface for applications.\n * @example\n * ```typescript\n * import { StorageManager, IPFSStorage, PinataStorage } from '@opendatalabs/vana-sdk';\n *\n * const storage = new StorageManager();\n *\n * // Register multiple providers\n * storage.register('ipfs', new IPFSStorage({\n *   apiEndpoint: 'https://api.pinata.cloud/pinning/pinFileToIPFS'\n * }), true);\n * storage.register('pinata', new PinataStorage({\n *   jwt: 'your-pinata-jwt-token'\n * }));\n *\n * // Upload to default provider\n * const result = await storage.upload(fileBlob, 'myfile.json');\n *\n * // Upload to specific provider\n * const result2 = await storage.upload(fileBlob, 'myfile.json', 'pinata');\n * ```\n * @category Storage\n * @see {@link https://docs.vana.com/developer/vana-sdk-documentation/core-modules/storage-providers | Storage Providers Guide} for configuration details\n */\nexport class StorageManager {\n  private providers: Map<string, StorageProvider> = new Map();\n  private defaultProvider: string | null = null;\n\n  /**\n   * Registers a storage provider with the manager.\n   *\n   * @remarks\n   * This method adds a new storage provider to the manager's registry and optionally\n   * sets it as the default provider for subsequent operations. If no default provider\n   * is currently set, the first registered provider automatically becomes the default.\n   * @param name - Unique identifier for the provider\n   * @param provider - The storage provider instance implementing the `StorageProvider` interface\n   * @param isDefault - Whether this provider should be set as the default (defaults to `false`)\n   * @example\n   * ```typescript\n   * const pinata = new PinataStorage({ jwt: 'your-jwt-token' });\n   * storage.register('pinata', pinata, true); // Set as default\n   *\n   * const ipfs = new IPFSStorage({ apiEndpoint: 'https://...' });\n   * storage.register('ipfs', ipfs); // Not default\n   * ```\n   */\n  register(name: string, provider: StorageProvider, isDefault = false): void {\n    this.providers.set(name, provider);\n\n    if (isDefault || this.defaultProvider === null) {\n      this.defaultProvider = name;\n    }\n  }\n\n  /**\n   * Get a registered storage provider\n   *\n   * @param name - Provider identifier, uses default if not specified\n   * @returns Storage provider instance\n   */\n  getProvider(name?: string): StorageProvider {\n    const providerName = name ?? this.defaultProvider;\n\n    if (!providerName) {\n      throw new StorageError(\n        \"No storage provider specified and no default provider set\",\n        \"NO_PROVIDER\",\n        \"manager\",\n      );\n    }\n\n    const provider = this.providers.get(providerName);\n    if (!provider) {\n      throw new StorageError(\n        `Storage provider '${providerName}' not found`,\n        \"PROVIDER_NOT_FOUND\",\n        \"manager\",\n      );\n    }\n\n    return provider;\n  }\n\n  /**\n   * List all registered providers\n   *\n   * @returns Array of provider names\n   */\n  listProviders(): string[] {\n    return Array.from(this.providers.keys());\n  }\n\n  /**\n   * Get the default provider name\n   *\n   * @returns Default provider name or null\n   */\n  getDefaultProvider(): string | null {\n    return this.defaultProvider;\n  }\n\n  /**\n   * Set the default provider\n   *\n   * @param name - Provider identifier\n   */\n  setDefaultProvider(name: string): void {\n    if (!this.providers.has(name)) {\n      throw new StorageError(\n        `Cannot set default provider '${name}': provider not registered`,\n        \"PROVIDER_NOT_FOUND\",\n        \"manager\",\n      );\n    }\n    this.defaultProvider = name;\n  }\n\n  /**\n   * Uploads a file using the specified or default storage provider.\n   *\n   * @remarks\n   * This method uploads a file to the specified provider or falls back to the default\n   * provider if none is specified. The upload result includes the storage URL, file size,\n   * content type, and provider-specific metadata that can be used for subsequent operations.\n   * @param file - The file blob to upload\n   * @param filename - Optional custom filename (defaults to auto-generated name)\n   * @param providerName - Optional provider identifier (uses default if not specified)\n   * @returns A Promise that resolves to the storage upload result with URL and metadata\n   * @throws {StorageError} When no provider is available or upload fails\n   * @example\n   * ```typescript\n   * // Upload to default provider\n   * const result = await storage.upload(fileBlob, 'data.json');\n   * console.log(`Uploaded to: ${result.url}`);\n   *\n   * // Upload to specific provider\n   * const result2 = await storage.upload(fileBlob, 'data.json', 'pinata');\n   * ```\n   */\n  async upload(\n    file: Blob,\n    filename?: string,\n    providerName?: string,\n  ): Promise<StorageUploadResult> {\n    const provider = this.getProvider(providerName);\n    return provider.upload(file, filename);\n  }\n\n  /**\n   * Download a file using the specified or default provider\n   *\n   * @param url - The storage URL\n   * @param providerName - Optional provider to use\n   * @returns Promise with file blob\n   */\n  async download(url: string, providerName?: string): Promise<Blob> {\n    const provider = this.getProvider(providerName);\n    return provider.download(url);\n  }\n\n  /**\n   * List files using the specified or default provider\n   *\n   * @param options - Optional filtering and pagination\n   * @param providerName - Optional provider to use\n   * @returns Promise with file list\n   */\n  async list(\n    options?: StorageListOptions,\n    providerName?: string,\n  ): Promise<StorageFile[]> {\n    const provider = this.getProvider(providerName);\n    return provider.list(options);\n  }\n\n  /**\n   * Delete a file using the specified or default provider\n   *\n   * @param url - The storage URL\n   * @param providerName - Optional provider to use\n   * @returns Promise with success status\n   */\n  async delete(url: string, providerName?: string): Promise<boolean> {\n    const provider = this.getProvider(providerName);\n    return provider.delete(url);\n  }\n\n  /**\n   * Get list of registered storage provider names\n   *\n   * @returns Array of provider names\n   */\n  getStorageProviders(): string[] {\n    return Array.from(this.providers.keys());\n  }\n\n  /**\n   * Get the default storage provider name\n   *\n   * @returns Default provider name or undefined\n   */\n  getDefaultStorageProvider(): string | undefined {\n    return this.defaultProvider ?? undefined;\n  }\n}\n"],"mappings":"AAMA,SAAS,oBAAoB;AAwCtB,MAAM,eAAe;AAAA,EAClB,YAA0C,oBAAI,IAAI;AAAA,EAClD,kBAAiC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAqBzC,SAAS,MAAc,UAA2B,YAAY,OAAa;AACzE,SAAK,UAAU,IAAI,MAAM,QAAQ;AAEjC,QAAI,aAAa,KAAK,oBAAoB,MAAM;AAC9C,WAAK,kBAAkB;AAAA,IACzB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,YAAY,MAAgC;AAC1C,UAAM,eAAe,QAAQ,KAAK;AAElC,QAAI,CAAC,cAAc;AACjB,YAAM,IAAI;AAAA,QACR;AAAA,QACA;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,UAAM,WAAW,KAAK,UAAU,IAAI,YAAY;AAChD,QAAI,CAAC,UAAU;AACb,YAAM,IAAI;AAAA,QACR,qBAAqB,YAAY;AAAA,QACjC;AAAA,QACA;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,gBAA0B;AACxB,WAAO,MAAM,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,qBAAoC;AAClC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,mBAAmB,MAAoB;AACrC,QAAI,CAAC,KAAK,UAAU,IAAI,IAAI,GAAG;AAC7B,YAAM,IAAI;AAAA,QACR,gCAAgC,IAAI;AAAA,QACpC;AAAA,QACA;AAAA,MACF;AAAA,IACF;AACA,SAAK,kBAAkB;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAwBA,MAAM,OACJ,MACA,UACA,cAC8B;AAC9B,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,OAAO,MAAM,QAAQ;AAAA,EACvC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,SAAS,KAAa,cAAsC;AAChE,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,SAAS,GAAG;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,KACJ,SACA,cACwB;AACxB,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,KAAK,OAAO;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,OAAO,KAAa,cAAyC;AACjE,UAAM,WAAW,KAAK,YAAY,YAAY;AAC9C,WAAO,SAAS,OAAO,GAAG;AAAA,EAC5B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,sBAAgC;AAC9B,WAAO,MAAM,KAAK,KAAK,UAAU,KAAK,CAAC;AAAA,EACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,4BAAgD;AAC9C,WAAO,KAAK,mBAAmB;AAAA,EACjC;AACF;","names":[]}