smartbucket/ts/classes.bucket.ts

import * as plugins from './plugins.js';
import { SmartBucket } from './classes.smartbucket.js';
import { Directory } from './classes.directory.js';

export class Bucket {
  public static async getBucketByName(smartbucketRef: SmartBucket, bucketNameArg: string) {
    const buckets = await smartbucketRef.minioClient.listBuckets();
    const foundBucket = buckets.find((bucket) => {
      return bucket.name === bucketNameArg;
    });

    if (foundBucket) {
      console.log(`bucket with name ${bucketNameArg} exists.`);
      console.log(`Taking this as base for new Bucket instance`);
      return new this(smartbucketRef, bucketNameArg);
    } else {
      return null;
    }
  }

  public static async createBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
    await smartbucketRef.minioClient.makeBucket(bucketName, 'ams3').catch((e) => console.log(e));
    return new Bucket(smartbucketRef, bucketName);
  }

  public static async removeBucketByName(smartbucketRef: SmartBucket, bucketName: string) {
    await smartbucketRef.minioClient.removeBucket(bucketName).catch((e) => console.log(e));
  }

  public smartbucketRef: SmartBucket;
  public name: string;

  constructor(smartbucketRef: SmartBucket, bucketName: string) {
    this.smartbucketRef = smartbucketRef;
    this.name = bucketName;
  }

  /**
   * gets the base directory of the bucket
   */
  public async getBaseDirectory() {
    return new Directory(this, null, '');
  }

  // ===============
  // Fast Operations
  // ===============

  /**
   * store file
   */
  public async fastPut(optionsArg: {
    path: string;
    contents: string | Buffer;
    overwrite?: boolean;
  }): Promise<void> {
    try {
      // Check if the object already exists
      const exists = await this.fastExists({ path: optionsArg.path });
  
      if (exists && !optionsArg.overwrite) {
        console.error(`Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`);
        return;
      } else if (exists && optionsArg.overwrite) {
        console.log(`Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`);
      } else {
        console.log(`Creating new object at path '${optionsArg.path}' in bucket '${this.name}'.`);
      }
  
      // Proceed with putting the object
      const streamIntake = new plugins.smartstream.StreamIntake();
      const putPromise = this.smartbucketRef.minioClient.putObject(this.name, optionsArg.path, streamIntake);
      streamIntake.pushData(optionsArg.contents);
      streamIntake.signalEnd();
      await putPromise;
  
      console.log(`Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`);
    } catch (error) {
      console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error);
      throw error;
    }
  }
  

  /**
   * get file
   */
  public async fastGet(optionsArg: Parameters<typeof this.fastGetStream>[0]): Promise<Buffer> {
    const done = plugins.smartpromise.defer();
    let completeFile: Buffer;
    const replaySubject = await this.fastGetStream(optionsArg);
    const subscription = replaySubject.subscribe({
      next: (chunk) => {
        if (completeFile) {
          completeFile = Buffer.concat([completeFile, chunk]);
        } else {
          completeFile = chunk;
        }
      },
      complete: () => {
        done.resolve();
        subscription.unsubscribe();
      },
      error: (err) => {
        console.log(err);
      },
    });
    await done.promise;
    return completeFile;
  }

  public async fastGetStream(optionsArg: {
    path: string;
  }): Promise<plugins.smartrx.rxjs.ReplaySubject<Buffer>> {
    const fileStream = await this.smartbucketRef.minioClient
      .getObject(this.name, optionsArg.path)
      .catch((e) => console.log(e));
    const replaySubject = new plugins.smartrx.rxjs.ReplaySubject<Buffer>();
    const duplexStream = new plugins.smartstream.SmartDuplex<Buffer, void>({
      writeFunction: async (chunk) => {
        replaySubject.next(chunk);
        return;
      },
      finalFunction: async (cb) => {
        replaySubject.complete();
        return;
      }
    });

    if (!fileStream) {
      return null;
    }

    const smartstream = new plugins.smartstream.StreamWrapper([
      fileStream,
      duplexStream,
    ]);
    smartstream.run();
    return replaySubject;
  }

  /**
   * store file as stream
   */
  public async fastPutStream(optionsArg: {
    path: string;
    dataStream: plugins.stream.Readable;
    nativeMetadata?: { [key: string]: string };
    overwrite?: boolean;
  }): Promise<void> {
    try {
      // Check if the object already exists
      const exists = await this.fastExists({ path: optionsArg.path });
  
      if (exists && !optionsArg.overwrite) {
        console.error(`Object already exists at path '${optionsArg.path}' in bucket '${this.name}'.`);
        return;
      } else if (exists && optionsArg.overwrite) {
        console.log(`Overwriting existing object at path '${optionsArg.path}' in bucket '${this.name}'.`);
      } else {
        console.log(`Creating new object at path '${optionsArg.path}' in bucket '${this.name}'.`);
      }
  
      // Proceed with putting the object
      await this.smartbucketRef.minioClient.putObject(
        this.name,
        optionsArg.path,
        optionsArg.dataStream,
        null,
        ...(optionsArg.nativeMetadata
          ? (() => {
              const returnObject: any = {};
              return returnObject;
            })()
          : {})
      );
  
      console.log(`Object '${optionsArg.path}' has been successfully stored in bucket '${this.name}'.`);
    } catch (error) {
      console.error(`Error storing object at path '${optionsArg.path}' in bucket '${this.name}':`, error);
      throw error;
    }
  }
  

  public async copyObject(optionsArg: {
    /**
     * the
     */
    objectKey: string;
    /**
     * in case you want to copy to another bucket specify it here
     */
    targetBucket?: Bucket;
    targetBucketKey?: string;
    /**
     * metadata will be merged with existing metadata
     */
    nativeMetadata?: { [key: string]: string };
    deleteExistingNativeMetadata?: boolean;
  }): Promise<void> {
    try {
      const targetBucketName = optionsArg.targetBucket ? optionsArg.targetBucket.name : this.name;

      // Retrieve current object information to use in copy conditions
      const currentObjInfo = await this.smartbucketRef.minioClient.statObject(
        targetBucketName,
        optionsArg.objectKey
      );

      // Setting up copy conditions
      const copyConditions = new plugins.minio.CopyConditions();

      // Prepare new metadata
      const newNativeMetadata = {
        ...(optionsArg.deleteExistingNativeMetadata ? {} : currentObjInfo.metaData),
        ...optionsArg.nativeMetadata,
      };

      // Define the copy operation as a Promise
      // TODO: check on issue here: https://github.com/minio/minio-js/issues/1286
      await this.smartbucketRef.minioClient.copyObject(
        this.name,
        optionsArg.objectKey,
        `/${targetBucketName}/${optionsArg.objectKey}`,
        copyConditions
      );
    } catch (err) {
      console.error('Error updating metadata:', err);
      throw err; // rethrow to allow caller to handle
    }
  }

  /**
   * removeObject
   */
  public async fastRemove(optionsArg: {
    path: string;
  }) {
    await this.smartbucketRef.minioClient.removeObject(this.name, optionsArg.path);
  }

  /**
   * check wether file exists
   * @param optionsArg
   * @returns 
   */
  public async fastExists(optionsArg: {
    path: string;
  }): Promise<boolean> {
    try {
      await this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path);
      console.log(`Object '${optionsArg.path}' exists in bucket '${this.name}'.`);
      return true;
    } catch (error) {
      if (error.code === 'NotFound') {
        console.log(`Object '${optionsArg.path}' does not exist in bucket '${this.name}'.`);
        return false;
      } else {
        console.error('Error checking object existence:', error);
        throw error; // Rethrow if it's not a NotFound error to handle unexpected issues
      }
    }
  }

  public async fastStat(optionsArg: {
    path: string;
  }) {
    return this.smartbucketRef.minioClient.statObject(this.name, optionsArg.path);
  }
}