@memberjunction/storage 3.2.0 → 3.4.0

package/dist/generic/FileStorageBase.d.ts

@@ -216,26 +216,41 @@ export declare class UnsupportedOperationError extends Error {
  * Configuration options for initializing a storage provider.
  * This interface defines the standard configuration that can be passed to initialize().
  *
- * In the enterprise model, every storage driver instance is associated with a
- * FileStorageAccount entity. The accountId is required to link the driver to
- * the specific organizational storage account it operates on behalf of.
+ * ## Usage Patterns
+ *
+ * ### Simple Deployment (Environment Variables)
+ * - Omit accountId when using environment variables
+ * - Constructor loads credentials automatically
+ * - Call initialize() with no config or empty object
+ *
+ * ### Multi-Tenant Enterprise (Database)
+ * - Provide accountId to link driver to FileStorageAccount
+ * - Include decrypted credentials from database
+ * - Or use initializeDriverWithAccountCredentials() utility
  */
 export interface StorageProviderConfig {
     /**
      * The ID of the FileStorageAccount entity this driver instance is operating for.
      * This links the driver to a specific organizational storage account.
      *
-     * Required in the enterprise model - every driver instance must be associated
-     * with a FileStorageAccount.
+     * **Optional**: Provide for multi-tenant mode to track account association.
+     * Omit for simple deployment using environment variables.
      */
-    accountId: string;
+    accountId?: string;
     /**
      * The name of the account (for logging/display purposes).
+     *
+     * **Optional**: Useful for logging and debugging in multi-tenant scenarios.
      */
     accountName?: string;
     /**
      * Provider-specific configuration values (e.g., API keys, bucket names, etc.).
-     * These are typically decrypted from the Credential entity at runtime.
+     *
+     * **Simple Deployment**: Not needed - constructor loads from environment variables.
+     * **Multi-Tenant**: Provide decrypted credentials from Credential entity.
+     *
+     * If provided, these values override the constructor defaults.
+     * If omitted, uses credentials already loaded by constructor.
      */
     [key: string]: unknown;
 }
@@ -654,52 +669,72 @@ export declare abstract class FileStorageBase {
      */
     abstract DirectoryExists(directoryPath: string): Promise<boolean>;
     /**
-     * Initialization method for storage providers.
+     * Initialize storage provider with optional configuration.
      *
-     * This method must be called before using the storage provider. It sets up the
-     * account association and can be overridden by subclasses to perform provider-specific
-     * initialization such as setting up access tokens, establishing connections, or
-     * verifying permissions.
+     * ## Standard Usage Pattern
      *
-     * The base implementation extracts and stores accountId and accountName from the config.
-     * Subclass implementations should call super.initialize(config) first to ensure these
-     * values are properly set before performing provider-specific initialization.
+     * **ALWAYS call this method** after creating a provider instance.
      *
-     * @param config - Configuration object containing account information and provider-specific
-     *                 settings. The accountId property is required and links this driver instance
-     *                 to a specific FileStorageAccount entity. Additional provider-specific values
-     *                 (e.g., API keys, bucket names) are typically decrypted from the associated
-     *                 Credential entity.
+     * ### Simple Deployment (Environment Variables)
+     * Constructor loads credentials from environment variables, then call
+     * initialize() with no config to complete setup:
      *
-     * @example
      * ```typescript
-     * // In a specific provider implementation:
-     * public async initialize(config: StorageProviderConfig): Promise<void> {
-     *   // Always call super first to set accountId and accountName
-     *   await super.initialize(config);
-     *
-     *   // Then handle provider-specific configuration
-     *   if (config.accessToken) {
-     *     this._client = new ProviderClient({ accessToken: config.accessToken as string });
-     *   }
-     *   await this.verifyBucketAccess();
-     * }
+     * // Set environment variables:
+     * // STORAGE_AWS_ACCESS_KEY_ID=...
+     * // STORAGE_AWS_SECRET_ACCESS_KEY=...
+     * // STORAGE_AWS_BUCKET_NAME=...
+     * // STORAGE_AWS_REGION=...
+     *
+     * const storage = new AWSFileStorage(); // Constructor loads env vars
+     * await storage.initialize(); // No config - uses env vars
+     * await storage.ListObjects('/'); // Ready to use
+     * ```
      *
-     * // Usage:
-     * const storage = new MyStorageProvider();
+     * ### Multi-Tenant Enterprise (Database)
+     * Constructor loads defaults, then call initialize() with configuration
+     * to override with database credentials and track account:
+     *
+     * ```typescript
+     * // Preferred: Use infrastructure utility
+     * const storage = await initializeDriverWithAccountCredentials({
+     *   accountEntity,
+     *   providerEntity,
+     *   contextUser
+     * });
+     *
+     * // Alternative: Manual initialization
+     * const storage = new AWSFileStorage();
      * await storage.initialize({
-     *   accountId: 'F1234567-89AB-CDEF-0123-456789ABCDEF',
-     *   accountName: 'Company AWS S3 Storage',
-     *   accessKeyId: 'AKIA...',
-     *   secretAccessKey: '...',
-     *   bucket: 'my-bucket'
+     *   accountId: account.id,
+     *   accountName: account.name,
+     *   accessKeyID: creds.accessKeyID,
+     *   secretAccessKey: creds.secretAccessKey,
+     *   region: creds.region,
+     *   defaultBucket: creds.bucket
      * });
-     * // Now the provider is ready to use
      * ```
      *
-     * @returns A Promise that resolves when initialization is complete.
+     * ## How It Works
+     *
+     * - **No config**: Uses credentials already loaded by constructor from environment variables
+     * - **With config**: Overrides constructor credentials with provided values
+     * - **accountId**: Optional - provide for multi-tenant tracking
+     *
+     * ## Implementation Notes for Subclasses
+     *
+     * Subclass implementations should:
+     * 1. Call super.initialize(config) first to set accountId and accountName
+     * 2. Check if config is provided before attempting to override credentials
+     * 3. Only override values that are present in config
+     * 4. Reinitialize client/connection if credentials changed
+     *
+     * @param config - Optional configuration object
+     *                 - Omit for simple deployment (uses env vars from constructor)
+     *                 - Provide for multi-tenant (overrides with database credentials)
+     * @returns A Promise that resolves when initialization is complete
      */
-    initialize(config: StorageProviderConfig): Promise<void>;
+    initialize(config?: StorageProviderConfig): Promise<void>;
     /**
      * Checks whether this storage provider is properly configured and ready to use.
      *

package/dist/generic/FileStorageBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FileStorageBase.d.ts","sourceRoot":"","sources":["../../src/generic/FileStorageBase.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,IAAI,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;IAClD;;;;;OAKG;gBACS,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAIrD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,eAAe;IACnC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;;OAGG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED;;;;;;OAMG;IACH,SAAS,CAAC,8BAA8B,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK;IAInE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAE3F;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE7F;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAElG;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAEtI;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,UAAU,CAAC,gBAAgB,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAErG;;;;;;;;;;;;;;;;;;;OAmBG;aACa,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAElE;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACU,UAAU,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAMrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,aAAoB,YAAY,IAAI,OAAO,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;aACa,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CACtG"}
+{"version":3,"file":"FileStorageBase.d.ts","sourceRoot":"","sources":["../../src/generic/FileStorageBase.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,IAAI,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACzC,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IAErB;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,IAAI,CAAC;IAEtB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC5C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,EAAE,IAAI,CAAC;IAEnB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAE5B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,KAAK;IAClD;;;;;OAKG;gBACS,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;CAIrD;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,8BAAsB,eAAe;IACnC;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAEjD;;;OAGG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,SAAS,CAAC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IAE3C;;;OAGG;IACH,IAAW,SAAS,IAAI,MAAM,GAAG,SAAS,CAEzC;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,MAAM,GAAG,SAAS,CAE3C;IAED;;;;;;OAMG;IACH,SAAS,CAAC,8BAA8B,CAAC,UAAU,EAAE,MAAM,GAAG,KAAK;IAInE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;aACa,sBAAsB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAElG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,wBAAwB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAE7E;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;aACa,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAE1F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;aACa,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAElE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;aACa,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAE3F;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAE7F;;;;;;;;;;;;;;;;;;;;;;OAsBG;aACa,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAElG;;;;;;;;;;;;;;;;;;;;;OAqBG;aACa,SAAS,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAEnE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;aACa,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAEtI;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;aACa,UAAU,CAAC,gBAAgB,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAErG;;;;;;;;;;;;;;;;;;;OAmBG;aACa,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAElE;;;;;;;;;;;;;;;;;;;OAmBG;aACa,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAExE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACU,UAAU,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAQtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2CG;IACH,aAAoB,YAAY,IAAI,OAAO,CAAC;IAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4DG;aACa,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;CACtG"}

package/dist/generic/FileStorageBase.js

@@ -76,55 +76,77 @@ class FileStorageBase {
         throw new UnsupportedOperationError(methodName, this.providerName);
     }
     /**
-     * Initialization method for storage providers.
+     * Initialize storage provider with optional configuration.
      *
-     * This method must be called before using the storage provider. It sets up the
-     * account association and can be overridden by subclasses to perform provider-specific
-     * initialization such as setting up access tokens, establishing connections, or
-     * verifying permissions.
+     * ## Standard Usage Pattern
      *
-     * The base implementation extracts and stores accountId and accountName from the config.
-     * Subclass implementations should call super.initialize(config) first to ensure these
-     * values are properly set before performing provider-specific initialization.
+     * **ALWAYS call this method** after creating a provider instance.
      *
-     * @param config - Configuration object containing account information and provider-specific
-     *                 settings. The accountId property is required and links this driver instance
-     *                 to a specific FileStorageAccount entity. Additional provider-specific values
-     *                 (e.g., API keys, bucket names) are typically decrypted from the associated
-     *                 Credential entity.
+     * ### Simple Deployment (Environment Variables)
+     * Constructor loads credentials from environment variables, then call
+     * initialize() with no config to complete setup:
      *
-     * @example
      * ```typescript
-     * // In a specific provider implementation:
-     * public async initialize(config: StorageProviderConfig): Promise<void> {
-     *   // Always call super first to set accountId and accountName
-     *   await super.initialize(config);
+     * // Set environment variables:
+     * // STORAGE_AWS_ACCESS_KEY_ID=...
+     * // STORAGE_AWS_SECRET_ACCESS_KEY=...
+     * // STORAGE_AWS_BUCKET_NAME=...
+     * // STORAGE_AWS_REGION=...
      *
-     *   // Then handle provider-specific configuration
-     *   if (config.accessToken) {
-     *     this._client = new ProviderClient({ accessToken: config.accessToken as string });
-     *   }
-     *   await this.verifyBucketAccess();
-     * }
+     * const storage = new AWSFileStorage(); // Constructor loads env vars
+     * await storage.initialize(); // No config - uses env vars
+     * await storage.ListObjects('/'); // Ready to use
+     * ```
+     *
+     * ### Multi-Tenant Enterprise (Database)
+     * Constructor loads defaults, then call initialize() with configuration
+     * to override with database credentials and track account:
+     *
+     * ```typescript
+     * // Preferred: Use infrastructure utility
+     * const storage = await initializeDriverWithAccountCredentials({
+     *   accountEntity,
+     *   providerEntity,
+     *   contextUser
+     * });
      *
-     * // Usage:
-     * const storage = new MyStorageProvider();
+     * // Alternative: Manual initialization
+     * const storage = new AWSFileStorage();
      * await storage.initialize({
-     *   accountId: 'F1234567-89AB-CDEF-0123-456789ABCDEF',
-     *   accountName: 'Company AWS S3 Storage',
-     *   accessKeyId: 'AKIA...',
-     *   secretAccessKey: '...',
-     *   bucket: 'my-bucket'
+     *   accountId: account.id,
+     *   accountName: account.name,
+     *   accessKeyID: creds.accessKeyID,
+     *   secretAccessKey: creds.secretAccessKey,
+     *   region: creds.region,
+     *   defaultBucket: creds.bucket
      * });
-     * // Now the provider is ready to use
      * ```
      *
-     * @returns A Promise that resolves when initialization is complete.
+     * ## How It Works
+     *
+     * - **No config**: Uses credentials already loaded by constructor from environment variables
+     * - **With config**: Overrides constructor credentials with provided values
+     * - **accountId**: Optional - provide for multi-tenant tracking
+     *
+     * ## Implementation Notes for Subclasses
+     *
+     * Subclass implementations should:
+     * 1. Call super.initialize(config) first to set accountId and accountName
+     * 2. Check if config is provided before attempting to override credentials
+     * 3. Only override values that are present in config
+     * 4. Reinitialize client/connection if credentials changed
+     *
+     * @param config - Optional configuration object
+     *                 - Omit for simple deployment (uses env vars from constructor)
+     *                 - Provide for multi-tenant (overrides with database credentials)
+     * @returns A Promise that resolves when initialization is complete
      */
     async initialize(config) {
-        // Extract and store account information from the config
-        this._accountId = config.accountId;
-        this._accountName = config.accountName;
+        // Extract and store account information from the config if provided
+        if (config) {
+            this._accountId = config.accountId;
+            this._accountName = config.accountName;
+        }
     }
 }
 exports.FileStorageBase = FileStorageBase;

package/dist/generic/FileStorageBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"FileStorageBase.js","sourceRoot":"","sources":["../../src/generic/FileStorageBase.ts"],"names":[],"mappings":";;;AAkOA;;;;GAIG;AACH,MAAa,yBAA0B,SAAQ,KAAK;IAClD;;;;;OAKG;IACH,YAAY,UAAkB,EAAE,YAAoB;QAClD,KAAK,CAAC,cAAc,UAAU,6BAA6B,YAAY,WAAW,CAAC,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAXD,8DAWC;AAgCD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAsB,eAAe;IAOnC;;;OAGG;IACO,UAAU,CAAqB;IAEzC;;OAEG;IACO,YAAY,CAAqB;IAE3C;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACO,8BAA8B,CAAC,UAAkB;QACzD,MAAM,IAAI,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACrE,CAAC;IAsXD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6CG;IACI,KAAK,CAAC,UAAU,CAAC,MAA6B;QACnD,wDAAwD;QACxD,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;IACzC,CAAC;CA8GF;AAjkBD,0CAikBC"}
+{"version":3,"file":"FileStorageBase.js","sourceRoot":"","sources":["../../src/generic/FileStorageBase.ts"],"names":[],"mappings":";;;AAkOA;;;;GAIG;AACH,MAAa,yBAA0B,SAAQ,KAAK;IAClD;;;;;OAKG;IACH,YAAY,UAAkB,EAAE,YAAoB;QAClD,KAAK,CAAC,cAAc,UAAU,6BAA6B,YAAY,WAAW,CAAC,CAAC;QACpF,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAC;IAC1C,CAAC;CACF;AAXD,8DAWC;AA+CD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAsB,eAAe;IAOnC;;;OAGG;IACO,UAAU,CAAqB;IAEzC;;OAEG;IACO,YAAY,CAAqB;IAE3C;;;OAGG;IACH,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;OAGG;IACH,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACO,8BAA8B,CAAC,UAAkB;QACzD,MAAM,IAAI,yBAAyB,CAAC,UAAU,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACrE,CAAC;IAsXD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiEG;IACI,KAAK,CAAC,UAAU,CAAC,MAA8B;QACpD,oEAAoE;QACpE,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;YACnC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CAAC;QACzC,CAAC;IACH,CAAC;CA8GF;AAvlBD,0CAulBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/storage",
-  "version": "3.2.0",
+  "version": "3.4.0",
   "description": "This library provides a set of objects that handle the interface between the server-side API and various cloud storage providers.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,10 +30,10 @@
     "@azure/identity": "^4.0.1",
     "@azure/storage-blob": "^12.17.0",
     "@google-cloud/storage": "^7.9.0",
-    "@memberjunction/core": "3.2.0",
-    "@memberjunction/core-entities": "3.2.0",
-    "@memberjunction/credentials": "3.2.0",
-    "@memberjunction/global": "3.2.0",
+    "@memberjunction/core": "3.4.0",
+    "@memberjunction/core-entities": "3.4.0",
+    "@memberjunction/credentials": "3.4.0",
+    "@memberjunction/global": "3.4.0",
     "@microsoft/mgt-element": "^3.1.3",
     "@microsoft/mgt-msal2-provider": "^3.1.3",
     "@microsoft/mgt-sharepoint-provider": "^3.1.3",

package/readme.md

@@ -53,19 +53,71 @@ This package depends on:
 
 ## Usage
 
-### Basic Setup
+### Standard Usage Pattern
 
-First, configure the environment variables required for your chosen storage provider(s). You can implement multiple providers simultaneously and switch between them based on your application requirements.
+**CRITICAL**: Always follow these steps when using storage providers:
 
-Refer to the documentation for each storage provider for detailed configuration requirements (see the "Storage Provider Configuration" section below).
+1. Create provider instance
+2. **Call `initialize()`** (with or without config)
+3. Use provider
+
+The `initialize()` method is smart enough to handle both simple deployments (environment variables) and multi-tenant deployments (database credentials).
+
+### Basic Setup - Simple Deployment (Environment Variables)
+
+For single-tenant applications, development, testing, or simple production deployments:
 
-#### Azure Blob Storage Example
 ```bash
-STORAGE_AZURE_CONTAINER=your-container-name
-STORAGE_AZURE_ACCOUNT_NAME=your-account-name
-STORAGE_AZURE_ACCOUNT_KEY=your-account-key
+# Example: Azure Blob Storage
+export STORAGE_AZURE_CONTAINER=your-container-name
+export STORAGE_AZURE_ACCOUNT_NAME=your-account-name
+export STORAGE_AZURE_ACCOUNT_KEY=your-account-key
+```
+
+```typescript
+import { AzureFileStorage } from '@memberjunction/storage';
+
+// Constructor loads environment variables
+const storage = new AzureFileStorage();
+
+// ALWAYS call initialize() - no config needed for env var deployments
+await storage.initialize();
+
+// Provider is now ready to use
+await storage.ListObjects('/');
+```
+
+### Multi-Tenant Enterprise (Database Credentials)
+
+For enterprise applications managing multiple storage accounts:
+
+```typescript
+import { FileStorageEngine } from '@memberjunction/core-entities';
+import { initializeDriverWithAccountCredentials } from '@memberjunction/storage/util';
+
+// Load account from database
+const engine = FileStorageEngine.Instance;
+await engine.Config(false, contextUser);
+
+const accountWithProvider = engine.GetAccountWithProvider(accountId);
+
+// Infrastructure utility handles credential decryption and initialization
+const storage = await initializeDriverWithAccountCredentials({
+  accountEntity: accountWithProvider.account,
+  providerEntity: accountWithProvider.provider,
+  contextUser
+});
+
+// Provider is ready - credentials were automatically decrypted and initialized
+await storage.ListObjects('/');
 ```
 
+**Key Advantage**: The `initializeDriverWithAccountCredentials()` utility:
+- Automatically retrieves the credential by ID
+- Decrypts it using CredentialEngine
+- Calls `initialize()` with the decrypted values
+- Returns a fully configured provider instance
+
 ### Using Utility Functions (Recommended)
 
 The library provides high-level utility functions that work with MemberJunction's entity system:
@@ -119,27 +171,41 @@ async function fileOperationsExample() {
 
 ### Direct Provider Usage
 
-You can also work directly with a storage provider by instantiating it using the MemberJunction class factory:
+You can work directly with a storage provider by instantiating it:
 
 ```typescript
 import { FileStorageBase } from '@memberjunction/storage';
 import { MJGlobal } from '@memberjunction/global';
 
 async function directProviderExample() {
-  // Create storage instance using the class factory (recommended)
-  const storage = MJGlobal.Instance.ClassFactory.CreateInstance<FileStorageBase>(
-    FileStorageBase, 
+  // Method 1: Direct instantiation (simple deployment with env vars)
+  const storage = new AzureFileStorage(); // Constructor loads env vars
+  await storage.initialize(); // ALWAYS call initialize()
+
+  // Method 2: Using class factory (dynamic provider selection)
+  const storage2 = MJGlobal.Instance.ClassFactory.CreateInstance<FileStorageBase>(
+    FileStorageBase,
     'Azure Blob Storage'
   );
-  
-  // Initialize the storage provider if needed
-  await storage.initialize();
-  
+  await storage2.initialize(); // ALWAYS call initialize()
+
+  // Method 3: Multi-tenant with manual initialization
+  const storage3 = new AzureFileStorage();
+  await storage3.initialize({
+    accountId: '12345',
+    accountName: 'Azure Account',
+    accountName: 'myaccount',
+    accountKey: '...',
+    defaultContainer: 'my-container'
+  });
+
+  // Now you can use any of the storage methods:
+
   // List all files in a directory
   const result = await storage.ListObjects('documents/');
   console.log('Files:', result.objects);
   console.log('Directories:', result.prefixes);
-  
+
   // Display detailed metadata for each file
   for (const file of result.objects) {
     console.log(`\nFile: ${file.name}`);
@@ -150,54 +216,61 @@ async function directProviderExample() {
     console.log(`  Modified: ${file.lastModified}`);
     console.log(`  Is Directory: ${file.isDirectory}`);
   }
-  
+
   // Create a directory
   const dirCreated = await storage.CreateDirectory('documents/reports/');
   console.log(`Directory created: ${dirCreated}`);
-  
+
   // Upload a file directly with metadata
   const content = Buffer.from('Hello, World!');
   const uploaded = await storage.PutObject(
-    'documents/reports/hello.txt', 
-    content, 
+    'documents/reports/hello.txt',
+    content,
     'text/plain',
-    { 
+    {
       author: 'John Doe',
       department: 'Engineering',
-      version: '1.0' 
+      version: '1.0'
     }
   );
   console.log(`File uploaded: ${uploaded}`);
-  
+
   // Get file metadata without downloading content
   const metadata = await storage.GetObjectMetadata('documents/reports/hello.txt');
   console.log('File metadata:', metadata);
-  
+
   // Download file content
   const fileContent = await storage.GetObject('documents/reports/hello.txt');
   console.log('File content:', fileContent.toString('utf8'));
-  
+
   // Copy a file
   const copied = await storage.CopyObject(
-    'documents/reports/hello.txt', 
+    'documents/reports/hello.txt',
     'documents/archive/hello-backup.txt'
   );
   console.log(`File copied: ${copied}`);
-  
+
   // Check if a file exists
   const exists = await storage.ObjectExists('documents/reports/hello.txt');
   console.log(`File exists: ${exists}`);
-  
+
   // Check if a directory exists
   const dirExists = await storage.DirectoryExists('documents/reports/');
   console.log(`Directory exists: ${dirExists}`);
-  
+
   // Delete a directory and all its contents
   const dirDeleted = await storage.DeleteDirectory('documents/reports/', true);
   console.log(`Directory deleted: ${dirDeleted}`);
 }
 ```
 
+### Key Principle
+
+**Always call `initialize()`** after creating a provider instance. It's smart enough to:
+- Use environment variables when called with no config
+- Override with database credentials when called with config
+- Handle both simple and multi-tenant deployments seamlessly
+
 ### Searching Files
 
 Providers with native search capabilities support the `SearchFiles` method for finding files by name, content, and metadata:
@@ -345,6 +418,7 @@ type FileSearchResultSet = {
 
 All storage providers implement these methods:
 
+- **`initialize(config?: StorageProviderConfig): Promise<void>`** - **REQUIRED**: Always call after creating instance. Omit config for env vars, provide config for multi-tenant.
 - `CreatePreAuthUploadUrl(objectName: string): Promise<CreatePreAuthUploadUrlPayload>`
 - `CreatePreAuthDownloadUrl(objectName: string): Promise<string>`
 - `MoveObject(oldObjectName: string, newObjectName: string): Promise<boolean>`
@@ -359,7 +433,6 @@ All storage providers implement these methods:
 - `ObjectExists(objectName: string): Promise<boolean>`
 - `DirectoryExists(directoryPath: string): Promise<boolean>`
 - `SearchFiles(query: string, options?: FileSearchOptions): Promise<FileSearchResultSet>` (throws `UnsupportedOperationError` for providers without native search)
-- `initialize(): Promise<void>` (optional, for async initialization)
 
 ### Utility Functions